VIAudioFile
File player that automatically prepares audio session and plays sounds.
Supported file formats are: .caf, .wav, .aiff, .aifc, .mp3, .ac3
Limitations:
- Playing audio file is not supported while there is an active connected call.
- Playing audio file may be interrupted if audio within a call is started.
- Playing audio file stops if Siri or CallKit is activated.
Props
delegate
@property (weak, nullable, nonatomic) delegateDelegate that handles events related to audio file playing process.
Returns
type:
delegateQueue
@property (strong, nullable, nonatomic) dispatch_queue_t
delegateQueueAll delegates methods are called on this queue. The queue should be serial, but not concurrent (the main queue is applicable).
If not specified, the main queue is used.
Returns
type:
dispatch_queue_t
looped
@property (assign, nonatomic) BOOL
loopedWhether to play audio file repeatedly in loop or once.
Returns
type:
BOOL
url
@property (strong, nullable, readonly, nonatomic) NSURL *
urlAudio file's URL.
Returns
type:
NSURL *
Methods
initWithData:looped:
- (nullable instancetype
)initWithData:(NSData *
)audioFileData
looped:(BOOL
)looped Initializes the audio file instance.
Parameters
audioFileData:
NSData *
Audio file Data
looped:
BOOL
Whether to play audio file repeatedly in loop or once
Returns
type:
nullable instancetype
initWithURL:looped:
- (nullable instancetype
)initWithURL:(NSURL *
)audioFileURL
looped:(BOOL
)looped Initializes the audio file instance.
Parameters
audioFileURL:
NSURL *
Audio file URL
looped:
BOOL
Whether to play audio file repeatedly in loop or once
Returns
type:
nullable instancetype
play
- (void
)playStarts playing the audio file repeatedly or once based on [VIAudioFile looped] property.
If the audio file is already playing, calling this method results in [VIAudioFileDelegate audioFile:didStartPlaying:] event with an error.
Returns
type:
void
stop
- (void
)stopStops playing the audio file.
Calling this method has no effect if the audio file is not playing.
Returns
type:
void