Inherits RefCountInterface.

Public Member Functions
virtual int	getSourceId () const =0

virtual int	open (const char *url, int64_t startPos)=0

virtual int	play ()=0

virtual int	pause ()=0

virtual int	stop ()=0

virtual int	resume ()=0

virtual int	seek (int64_t newPos)=0

virtual int	getDuration (int64_t &duration)=0

virtual int	getPlayPosition (int64_t &pos)=0

virtual int	getStreamCount (int64_t &count)=0

virtual int	getStreamInfo (int64_t index, media::base::MediaStreamInfo *info)=0

virtual int	setLoopCount (int loopCount)=0

virtual int	changePlaybackSpeed (media::base::MEDIA_PLAYER_PLAYBACK_SPEED speed)=0

virtual int	selectAudioTrack (int index)=0

virtual int	setPlayerOption (const char *key, int value)=0

virtual int	setPlayerOption (const char key, const char value)=0

virtual int	setExternalSubtitle (const char *url)=0

virtual media::base::MEDIA_PLAYER_STATE	getState ()=0

virtual int	registerPlayerSourceObserver (IMediaPlayerSourceObserver *observer)=0

virtual int	unregisterPlayerSourceObserver (IMediaPlayerSourceObserver *observer)=0

virtual int	registerAudioFrameObserver (media::base::IAudioFrameObserver *observer)=0

virtual int	unregisterAudioFrameObserver (media::base::IAudioFrameObserver *observer)=0

Protected Member Functions
virtual	~IMediaPlayerSource ()=default

Detailed Description

The IMediaPlayerSource class provides access to a media player source. To playout multiple media sources simultaneously, create multiple media player source objects.

Constructor & Destructor Documentation

◆ ~IMediaPlayerSource()

virtual agora::rtc::IMediaPlayerSource::~IMediaPlayerSource ( )

protectedvirtualdefault

Member Function Documentation

◆ getSourceId()

virtual int agora::rtc::IMediaPlayerSource::getSourceId ( ) const

pure virtual

Get unique source id of the media player source.

Returns

>= 0: The source id of this media player source.
< 0: Failure.

◆ open()

virtual int agora::rtc::IMediaPlayerSource::open	(	const char *	url,
		int64_t	startPos
	)

pure virtual

Opens the media resource.

Parameters

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

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ play()

virtual int agora::rtc::IMediaPlayerSource::play ( )

pure virtual

Plays the media resource.

After open() or pause() or seek(), you can call this method to play the media resource.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ pause()

virtual int agora::rtc::IMediaPlayerSource::pause ( )

pure virtual

Pauses the playback.

To resume the playback, call the play() method.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ stop()

virtual int agora::rtc::IMediaPlayerSource::stop ( )

pure virtual

Stops the playback.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ resume()

virtual int agora::rtc::IMediaPlayerSource::resume ( )

pure virtual

Resumes the playback.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ seek()

virtual int agora::rtc::IMediaPlayerSource::seek ( int64_t newPos )

pure virtual

Seeks to a new playback position.

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

Parameters

pos	The new playback position (ms).

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ getDuration()

virtual int agora::rtc::IMediaPlayerSource::getDuration ( int64_t & duration )

pure virtual

Gets the duration of the media resource.

Parameters

[out] duration The total duration (ms) of the media resource.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ getPlayPosition()

virtual int agora::rtc::IMediaPlayerSource::getPlayPosition ( int64_t & pos )

pure virtual

Gets current playback progress.

Parameters

[out] pos The playback progress (ms).

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ getStreamCount()

virtual int agora::rtc::IMediaPlayerSource::getStreamCount ( int64_t & count )

pure virtual

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

Parameters

[out] count The number of the media streams in the media resource.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ getStreamInfo()

virtual int agora::rtc::IMediaPlayerSource::getStreamInfo	(	int64_t	index,
		media::base::MediaStreamInfo *	info
	)

pure virtual

Gets the detailed information of the media stream.

Parameters

	index	The index of the media stream.
[out]	info	The detailed information of the media stream. See MediaStreamInfo for details.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ setLoopCount()

virtual int agora::rtc::IMediaPlayerSource::setLoopCount ( int loopCount )

pure virtual

Sets the loop playback.

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

When the loop playback ends, MediaPlayer Kit returns PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED.

Parameters

loopCount The number of the loops.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ changePlaybackSpeed()

virtual int agora::rtc::IMediaPlayerSource::changePlaybackSpeed ( media::base::MEDIA_PLAYER_PLAYBACK_SPEED speed )

pure virtual

Adjusts the playback speed.

Call this method after the play() method.

Parameters

speed The playback speed. See MEDIA_PLAYER_PLAYBACK_SPEED for details

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ selectAudioTrack()

virtual int agora::rtc::IMediaPlayerSource::selectAudioTrack ( int index )

pure virtual

Selects the audio track.

When the media resource contains more than one audio track, you can call this method to select which audio track to use.

Parameters

index The index of the audio track.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ setPlayerOption() [1/2]

virtual int agora::rtc::IMediaPlayerSource::setPlayerOption	(	const char *	key,
		int	value
	)

pure virtual

Sets the private options for the MediaPlayer Kit.

The MediaPlayer Kit supports setting private options by providing key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.

Note: Calling this method before the open method.

Parameters

key	key.
value	value.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ setPlayerOption() [2/2]

virtual int agora::rtc::IMediaPlayerSource::setPlayerOption	(	const char *	key,
		const char *	value
	)

pure virtual

Sets the private options for the MediaPlayer Kit.

The MediaPlayer Kit supports setting private options by providing key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.

Note: Calling this method before the open method.

Parameters

key	key.
value	value.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ setExternalSubtitle()

virtual int agora::rtc::IMediaPlayerSource::setExternalSubtitle ( const char * url )

pure virtual

Sets the external subtitle.

After opening the media file, you can call this method set the mediaplayer kit to display the external subtitle.

Parameters

url	The URL address of the external subtitle. Both SRT subtitle and ASS subtitle, local address and online address are supported.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ getState()

virtual media::base::MEDIA_PLAYER_STATE agora::rtc::IMediaPlayerSource::getState ( )

pure virtual

Gets current playback state.

Returns

The current playback state.

0: Success.See MEDIA_PLAYER_STATE for details.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ registerPlayerSourceObserver()

virtual int agora::rtc::IMediaPlayerSource::registerPlayerSourceObserver ( IMediaPlayerSourceObserver * observer )

pure virtual

Registers a media player source observer.

Once the media player source observer is registered, you can use the observer to monitor the state change of the media player.

Parameters

observer The pointer to the IMediaPlayerSourceObserver object.

Returns

0: Success.
< 0: Failure.

◆ unregisterPlayerSourceObserver()

virtual int agora::rtc::IMediaPlayerSource::unregisterPlayerSourceObserver ( IMediaPlayerSourceObserver * observer )

pure virtual

Releases the media player source observer.

Parameters

observer The pointer to the IMediaPlayerSourceObserver object.

Returns

0: Success.
< 0: Failure.

◆ registerAudioFrameObserver()

virtual int agora::rtc::IMediaPlayerSource::registerAudioFrameObserver ( media::base::IAudioFrameObserver * observer )

pure virtual

Registers an audio observer.

Parameters

observer The audio observer, reporting the reception of each audio frame. See IAudioFrameObserver for details.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

◆ unregisterAudioFrameObserver()

virtual int agora::rtc::IMediaPlayerSource::unregisterAudioFrameObserver ( media::base::IAudioFrameObserver * observer )

pure virtual

Unregisters an audio observer.

Parameters

observer The audio observer, reporting the reception of each audio frame. See IAudioFrameObserver for details.

Returns

0: Success.
< 0: Failure. See MEDIA_PLAYER_ERROR for details.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMediaPlayerSource()

Member Function Documentation

◆ getSourceId()

◆ open()

◆ play()

◆ pause()

◆ stop()

◆ resume()

◆ seek()

◆ getDuration()

◆ getPlayPosition()

◆ getStreamCount()

◆ getStreamInfo()

◆ setLoopCount()

◆ changePlaybackSpeed()

◆ selectAudioTrack()

◆ setPlayerOption() [1/2]

◆ setPlayerOption() [2/2]

◆ setExternalSubtitle()

◆ getState()

◆ registerPlayerSourceObserver()

◆ unregisterPlayerSourceObserver()

◆ registerAudioFrameObserver()

◆ unregisterAudioFrameObserver()