IMediaPlayer

addListener

addListener?<EventType extends keyof IMediaPlayerEvent>(
      eventType: EventType,
      listener: IMediaPlayerEvent[EventType]
    ): void;

Details

After calling this method, you can listen for the corresponding events in the IMediaPlayer object and obtain data through IMediaPlayerEvent. Depending on your project needs, you can add multiple listeners for the same event.

Parameters

eventType

The name of the target event to listen for. See IMediaPlayerEvent.

listener

The callback function for eventType. Take adding a listener for onPlayerSourceStateChanged as an example:

const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);

adjustPlayoutVolume

Adjusts the local playback volume.

abstract adjustPlayoutVolume(volume: number): number;

Call timing

This method can be called either before or after joining the channel.

Restrictions

None.

Parameters

volume

The local playback volume, which ranges from 0 to 100:

0: Mute.
100: (Default) The original volume.

Returns

0: Success.
< 0: Failure.

adjustPublishSignalVolume

Adjusts the volume of the media file for publishing.

abstract adjustPublishSignalVolume(volume: number): number;

After connected to the Agora server, you can call this method to adjust the volume of the media file heard by the remote user.

Call timing

This method can be called either before or after joining the channel.

Restrictions

None.

Parameters

volume

The volume, which ranges from 0 to 400:

0: Mute.
100: (Default) The original volume.
400: Four times the original volume (amplifying the audio signals by four times).

Returns

0: Success.
< 0: Failure.

getDuration

Gets the duration of the media resource.

abstract getDuration(): number;

Returns

The total duration (ms) of the media file.

getMediaPlayerCacheManager

Gets one IMediaPlayerCacheManager instance.

export function getMediaPlayerCacheManager(): IMediaPlayerCacheManager {
  return new IMediaPlayerCacheManagerImpl();
}

Before calling any APIs in the IMediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.

Call timing

Make sure the IRtcEngine is initialized before you call this method.

Restrictions

The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance.

Returns

The IMediaPlayerCacheManager instance.

getMediaPlayerId

Gets the ID of the media player.

abstract getMediaPlayerId(): number;

Returns

Success. The ID of the media player.
< 0: Failure.

getMute

Reports whether the media resource is muted.

abstract getMute(): boolean;

Returns

true: Reports whether the media resource is muted.
false: Reports whether the media resource is muted.

getPlayoutVolume

Gets the local playback volume.

abstract getPlayoutVolume(): number;

Returns

The local playback volume, which ranges from 0 to 100.

0: Mute.
100: (Default) The original volume.

getPlayPosition

Gets current local playback progress.

abstract getPlayPosition(): number;

Returns

Returns the current playback progress (ms) if the call succeeds.
< 0: Failure. See MediaPlayerReason.

getPlaySrc

Gets the path of the media resource being played.

abstract getPlaySrc(): string;

Returns

The path of the media resource being played.

getPublishSignalVolume

Gets the volume of the media file for publishing.

abstract getPublishSignalVolume(): number;

Returns

≥ 0: The remote playback volume.
< 0: Failure.

getState

Gets current playback state.

abstract getState(): MediaPlayerState;

Returns

The current playback state. See MediaPlayerState.

getStreamCount

Gets the number of the media streams in the media resource.

abstract getStreamCount(): number;

Details

Attention: Call this method after you call open and receive the onPlayerSourceStateChanged callback reporting the state PlayerStateOpenCompleted.

Returns

The number of the media streams in the media resource if the method call succeeds.
< 0: Failure. See MediaPlayerReason.

getStreamInfo

Gets the detailed information of the media stream.

abstract getStreamInfo(index: number): PlayerStreamInfo;

Call timing

Call this method after calling getStreamCount.

Restrictions

None.

Parameters

index: The index of the media stream. This parameter must be less than the return value of getStreamCount.

Returns

If the call succeeds, returns the detailed information of the media stream. See PlayerStreamInfo.
null, if the method call fails.

mute

Sets whether to mute the media file.

abstract mute(muted: boolean): number;

Call timing

You can call this method either before or after joining a channel.

Restrictions

None.

Parameters

muted

Whether to mute the media file:

true: Mute the media file.
false: (Default) Unmute the media file.

Returns

0: Success.
< 0: Failure.

open

Opens the media resource.

abstract open(url: string, startPos: number): number;

Attention:

Call timing

This method can be called either before or after joining the channel.

Restrictions

None.

Related callbacks

After calling this method, the SDK triggers the onPlayerSourceStateChanged callback. After receiving the report of the playback status as PlayerStateOpenCompleted, you can call the play method to play the media file.

Parameters

url: The path of the media file. Both local path and online path are supported.
startPos: The starting position (ms) for playback. Default value is 0.

Returns

0: Success.
< 0: Failure.

openWithMediaSource

Opens a media file and configures the playback scenarios.

abstract openWithMediaSource(source: MediaSource): number;

This method supports opening media files of different sources, including a custom media source, and allows you to configure the playback scenarios.

Call timing

You can call this method either before or after joining a channel.

Restrictions

This method is called asynchronously. If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.

Parameters

source: Media resources. See MediaSource.

Returns

0: Success.
< 0: Failure.

pause

Pauses the playback.

abstract pause(): number;

Call timing

You can call this method either before or after joining a channel.

Restrictions

None.

Returns

0: Success.
< 0: Failure.

play

Plays the media file.

abstract play(): number;

Call timing

Call this method after calling open or openWithMediaSource opening a media file and receiving a onPlayerSourceStateChanged callback reporting the status as PlayerStateOpenCompleted.
Call the method after calling seek.

Restrictions

None.

Returns

0: Success.
< 0: Failure.

playPreloadedSrc

Plays preloaded media resources.

abstract playPreloadedSrc(src: string): number;

Details

After calling the preloadSrc method to preload the media resource into the playlist, you can call this method to play the preloaded media resource. After calling this method, if you receive the onPlayerSourceStateChanged callback which reports the PlayerStatePlaying state, the playback is successful.

If you want to change the preloaded media resource to be played, you can call this method again and specify the URL of the new media resource that you want to preload. If you want to replay the media resource, you need to call preloadSrc to preload the media resource to the playlist again before playing. If you want to clear the playlist, call the stop method.

Note:

If you call this method when playback is paused, this method does not take effect until playback is resumed.

Parameters

src: The URL of the media resource in the playlist must be consistent with the src set by the preloadSrc method; otherwise, the media resource cannot be played.

Returns

0: Success.
< 0: Failure.

preloadSrc

Preloads a media resource.

abstract preloadSrc(src: string, startPos: number): number;

Details

You can call this method to preload a media resource into the playlist. If you need to preload multiple media resources, you can call this method multiple times.

After calling this method, if you receive the PlayerPreloadEventComplete event in the onPreloadEvent callback, the preload is successful; If you receive the PlayerPreloadEventError event in the onPreloadEvent callback, the preload fails.

If the preload is successful and you want to play the media resource, call playPreloadedSrc; if you want to clear the playlist, call stop.

Note:

Before calling this method, ensure that you have called open or openWithMediaSource to open the media resource successfully.
Agora does not support preloading duplicate media resources to the playlist. However, you can preload the media resources that are being played to the playlist again.

Parameters

src: The URL of the media resource.
startPos: The starting position (ms) for playing after the media resource is preloaded to the playlist. When preloading a live stream, set this parameter to 0.

Returns

0: Success.
< 0: Failure.

registerAudioFrameObserver

Registers an audio frame observer object.

abstract registerAudioFrameObserver(
    observer: IAudioPcmFrameSink,
    mode?: RawAudioFrameOpModeType
  ): number;

Parameters

observer: The audio frame observer, reporting the reception of each audio frame. See IAudioPcmFrameSink.
mode: The use mode of the audio frame. See RawAudioFrameOpModeType.

Returns

0: Success.
< 0: Failure.

registerPlayerSourceObserver

Registers a media player observer.

abstract registerPlayerSourceObserver(
    observer: IMediaPlayerSourceObserver
  ): number;

Call timing

This method can be called either before or after joining the channel.

Restrictions

None.

Parameters

observer: The player observer, listening for events during the playback. See IMediaPlayerSourceObserver.

Returns

0: Success.
< 0: Failure.

registerVideoFrameObserver

Registers a video frame observer object.

abstract registerVideoFrameObserver(
    observer: IMediaPlayerVideoFrameObserver
  ): number;

Details

You need to implement the IMediaPlayerVideoFrameObserver class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.

Parameters

observer: The video observer, reporting the reception of each video frame. See IMediaPlayerVideoFrameObserver.

Returns

0: Success.
< 0: Failure.

removeAllListeners

Removes all listeners for the specified event.

removeAllListeners?<EventType extends keyof IMediaPlayerEvent>(
      eventType?: EventType
    ): void;

Parameters

eventType: The name of the target event to listen for. See IMediaPlayerEvent.

removeListener

Removes the specified IMediaPlayerEvent listener.

removeListener?<EventType extends keyof IMediaPlayerEvent>(
      eventType: EventType,
      listener: IMediaPlayerEvent[EventType]
    ): void;

Details

For listened events, if you no longer need to receive the callback message, you can call this method to remove the corresponding listener.

Parameters

eventType

The name of the target event to listen for. See IMediaPlayerEvent.

listener

The callback function for eventType. Must pass in the same function object in addListener. Take removing the listener for onPlayerSourceStateChanged as an example:

// Create an onPlayerSourceStateChanged object
const onPlayerSourceStateChanged = (state: MediaPlayerState, ec: MediaPlayerError) => {};
// Add one onPlayerSourceStateChanged listener
engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
// Remove the onPlayerSourceStateChanged listener
engine.removeListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);

resume

Resumes playing the media file.

abstract resume(): number;

Returns

0: Success.
< 0: Failure.

seek

Seeks to a new playback position.

abstract seek(newPos: number): number;

If you call seek after the playback has completed (upon receiving callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaybackCompleted or PlayerStatePlaybackAllLoopsCompleted), the SDK will play the media file from the specified position. At this point, you will receive callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaying.
If you call seek while the playback is paused, upon successful call of this method, the SDK will seek to the specified position. To resume playback, call resume orplay .

Call timing

You can call this method either before or after joining a channel.

Restrictions

None.

Related callbacks

After successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position.

Parameters

newPos: The new playback position (ms).

Returns

0: Success.
< 0: Failure.

selectAudioTrack

Selects the audio track used during playback.

abstract selectAudioTrack(index: number): number;

Details

After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.

Attention: You need to call this method after calling getStreamInfo to get the audio stream index value.

Parameters

index: The index of the audio track.

Returns

0: Success.
< 0: Failure.

setAudioPitch

Sets the pitch of the current media resource.

abstract setAudioPitch(pitch: number): number;

Details

Note: Call this method after calling open.

Parameters

pitch: Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.

Returns

0: Success.
< 0: Failure.

setAudioDualMonoMode

Sets the channel mode of the current audio file.

abstract setAudioDualMonoMode(mode: AudioDualMonoMode): number;

Details

In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.

Attention:

Call this method after calling open.
This method only applies to stereo audio files.

Parameters

mode: The channel mode. See AudioDualMonoMode.

Returns

0: Success.
< 0: Failure.

setLoopCount

Sets the loop playback.

abstract setLoopCount(loopCount: number): number;

Details

If you want to loop, call this method and set the number of the loops.

When the loop finishes, the SDK triggers onPlayerSourceStateChanged and reports the playback state as PlayerStatePlaybackAllLoopsCompleted.

Parameters

loopCount

The number of times the audio effect loops:

≥0: Number of times for playing. For example, setting it to 0 means no loop playback, playing only once; setting it to 1 means loop playback once, playing a total of twice.
-1: Play the audio file in an infinite loop.

Returns

0: Success.
< 0: Failure.

setPlaybackSpeed

Sets the channel mode of the current audio file.

abstract setPlaybackSpeed(speed: number): number;

Details

Call this method after calling open.

Parameters

speed

The playback speed. Agora recommends that you set this to a value between 30 and 400, defined as follows:

30: 0.3 times the original speed.
100: The original speed.
400: 4 times the original speed.

Returns

0: Success.
< 0: Failure.

setPlayerOptionInInt

Sets media player options.

abstract setPlayerOptionInInt(key: string, value: number): number;

The media player supports setting options through key and value.

The difference between this method and setPlayerOptionInString is that the value parameter of this method is of type Int, while the value of setPlayerOptionInString is of type String. These two methods cannot be used together.

Applicable scenarios

Scenarios that require technical previews or special customization features. In general, you do not need to call this method; you can simply use the default options provided by the media player.

Call timing

Call this method before the open or openWithMediaSource method.

Restrictions

None.

Parameters

key: The key of the option.
value: The value of the key.

Returns

0: Success.
< 0: Failure.

setPlayerOptionInString

Sets media player options.

abstract setPlayerOptionInString(key: string, value: string): number;

The media player supports setting options through key and value.

The difference between this method and setPlayerOptionInInt is that the value parameter of this method is of type String, while the value of setPlayerOptionInInt is of type String. These two methods cannot be used together.

Applicable scenarios

Scenarios that require technical previews or special customization features. In general, you do not need to call this method; you can simply use the default options provided by the media player.

Call timing

Call this method before the open or openWithMediaSource method.

Restrictions

None.

Parameters

key: The key of the option.
value: The value of the key.

Returns

0: Success.
< 0: Failure.

setRenderMode

Sets the render mode of the media player.

abstract setRenderMode(renderMode: RenderModeType): number;

Parameters

renderMode: Sets the render mode of the view. See RenderModeType.

Returns

0: Success.
< 0: Failure.

setSpatialAudioParams

Enables or disables the spatial audio effect for the media player.

abstract setSpatialAudioParams(params: SpatialAudioParams): number;

Details

After successfully setting the spatial audio effect parameters of the media player, the SDK enables the spatial audio effect for the media player, and the local user can hear the media resources with a sense of space.

If you need to disable the spatial audio effect for the media player, set the params parameter to null.

Parameters

The spatial audio effect parameters of the media player. See SpatialAudioParams.

Returns

0: Success.
< 0: Failure.

setView

Sets the view.

abstract setView(view: any): number;

Call timing

You can call this method either before or after joining a channel.

Restrictions

None.

Parameters

view: The render view.

Returns

0: Success.
< 0: Failure.

stop

Stops playing the media track.

abstract stop(): number;

After calling this method to stop playback, if you want to play again, you need to call open or openWithMediaSource to open the media resource.

Call timing

Call this method after play.

Restrictions

None.

Returns

0: Success.
< 0: Failure.

switchSrc

Switches the media resource being played.

abstract switchSrc(src: string, syncPts?: boolean): number;

Details

You can call this method to switch the media resource to be played according to the current network status. For example:

When the network is poor, the media resource to be played is switched to a media resource address with a lower bitrate.
When the network is good, the media resource to be played is switched to a media resource address with a higher bitrate.

After calling this method, if you receive the onPlayerEvent callback report the PlayerEventSwitchComplete event, the switching is successful. If the switching fails, the SDK will automatically retry 3 times. If it still fails, you will receive the onPlayerEvent callback reporting the PlayerEventSwitchError event indicating an error occurred during media resource switching.

Attention:

Ensure that you call this method after open.
To ensure normal playback, pay attention to the following when calling this method:
- Do not call this method when playback is paused.
- Do not call the seek method during switching.
- Before switching the media resource, make sure that the playback position does not exceed the total duration of the media resource to be switched.

Parameters

src

The URL of the media resource.

syncPts

Whether to synchronize the playback position (ms) before and after the switch:

true: Synchronize the playback position before and after the switch.
false: (Default) Do not synchronize the playback position before and after the switch.

Returns

unloadSrc

Unloads media resources that are preloaded.

abstract unloadSrc(src: string): number;

Details

Attention:

This method cannot release the media resource being played.

Parameters

src: The URL of the media resource.

Returns

0: Success.
< 0: Failure.

unregisterAudioFrameObserver

Unregisters an audio frame observer.

abstract unregisterAudioFrameObserver(observer: IAudioPcmFrameSink): number;

Parameters

observer: The audio observer. See IAudioPcmFrameSink.

Returns

0: Success.
< 0: Failure.

unregisterPlayerSourceObserver

Releases a media player observer.

abstract unregisterPlayerSourceObserver(
    observer: IMediaPlayerSourceObserver
  ): number;

Parameters

observer: The player observer, listening for events during the playback. See IMediaPlayerSourceObserver.

Returns

0: Success.
< 0: Failure.

unregisterVideoFrameObserver

Unregisters the video frame observer.

abstract unregisterVideoFrameObserver(
    observer: IMediaPlayerVideoFrameObserver
  ): number;

Parameters

observer: The video observer, reporting the reception of each video frame. See IMediaPlayerVideoFrameObserver.

Returns

0: Success.
< 0: Failure.