AudioFile
Methods
initWithLocalFile(name: string
, type: string
, usage: ): Promise<void>
Initializes an AudioFile instance to play local audio file.On android, the audio file should be located in resources "raw" folder.
Parameters
name:
string
Local audio file name
type:
string
Local audio file type/format, for example ".mp3"
usage:
Audio file usage mode. ANDROID ONLY.
Returns
type:
Promise<void>
loadFile(url: string
, usage: ): Promise<void>
Initializes an AudioFile to play a stream from a network.
Parameters
url:
string
HTTP URL of the stream to play
usage:
Audio file usage mode. ANDROID ONLY.
Returns
type:
Promise<void>
off(eventType: , event: Function
): void
Removes a handler for the specified AudioFile event.
Parameters
eventType:
event:
Function
OptionalHandler function. If not specified, all handlers for the event are removed.
Returns
type:
void
on(eventType: , event: Function
): void
Registers a handler for the specified AudioFile event. One event can have more than one handler. Use the [AudioFile#off] method to delete a handler.
Parameters
eventType:
event:
Function
Returns
type:
void
play(looped: boolean
): Promise<AudioFileEventTypes.Started>
Starts playing the audio file repeatedly or once.
Parameters
looped:
boolean
Whether the audio file should be played repeatedly or once
Returns
type:
Promise<AudioFileEventTypes.Started>
releaseResources(): void
Releases all resources allocated to play the audio file.Should be called even if the audio file has not been played.
Returns
type:
void
stop(): Promise<AudioFileEventTypes.Stopped>
Stops playing of the audio file.
Returns
type:
Promise<AudioFileEventTypes.Stopped>
Props
looped: boolean
Whether the audio file should be played repeatedly or once.
name: string
| null
Local audio file name.
url: string
| null
HTTP URL of the stream to play.