Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.mediaplayer.IMediaPlayer Interface Reference

Public Member Functions

int getMediaPlayerId ()
 
int open (String url, long startPos)
 
int play ()
 
int pause ()
 
int stop ()
 
int resume ()
 
int seek (long newPos)
 
int mute (boolean mute)
 Turn mute on or off. More...
 
boolean isMuted ()
 Get mute state. More...
 
int adjustPlayoutVolume (int volume)
 Adjust playback volume. More...
 
int getPlayoutVolume ()
 Get the current playback volume. More...
 
long getPlayPosition ()
 
long getDuration ()
 Get media duration. More...
 
Constants.MediaPlayerState getState ()
 Get player state. More...
 
int getStreamCount ()
 Get the number of streams in the media. More...
 
int setView (View videoView)
 Set video rendering view. More...
 
int setRenderMode (int mode)
 Set video display mode. More...
 
MediaStreamInfo getStreamInfo (int index)
 
int setLoopCount (int loopCount)
 
int changePlaybackSpeed (Constants.MediaPlayerPlaybackSpeed speed)
 
int selectAudioTrack (int index)
 
int setPlayerOption (String key, int value)
 
int takeScreenshot (String filename)
 
int selectInternalSubtitle (int index)
 
int setExternalSubtitle (String url)
 
int adjustPublishSignalVolume (int volume)
 adjust publish signal volume More...
 
int getPublishSignalVolume ()
 get publish signal volume More...
 
String getPlaySrc ()
 
int destroy ()
 
int registerPlayerObserver (IMediaPlayerObserver playerObserver)
 
int unRegisterPlayerObserver (IMediaPlayerObserver playerObserver)
 
int registerAudioFrameObserver (IMediaPlayerAudioFrameObserver audioFrameObserver, int mode)
 

Member Function Documentation

◆ getMediaPlayerId()

int io.agora.mediaplayer.IMediaPlayer.getMediaPlayerId ( )

Get unique source id of the media player.

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

◆ open()

int io.agora.mediaplayer.IMediaPlayer.open ( String  url,
long  startPos 
)

Opens a media file with a specified URL.

Parameters
urlThe URL of the media file that you want to play.
Returns
  • 0: Success.
  • < 0: Failure.

◆ play()

int io.agora.mediaplayer.IMediaPlayer.play ( )

Plays the media file.

Returns
  • 0: Success.
  • < 0: Failure.

◆ pause()

int io.agora.mediaplayer.IMediaPlayer.pause ( )

Pauses playing the media file.

◆ stop()

int io.agora.mediaplayer.IMediaPlayer.stop ( )

Stops playing the current media file.

◆ resume()

int io.agora.mediaplayer.IMediaPlayer.resume ( )

Resumes playing the media file.

◆ seek()

int io.agora.mediaplayer.IMediaPlayer.seek ( long  newPos)

Sets the current playback position of the media file.

Parameters
newPosThe new playback position (ms).
Returns
  • 0: Success.
  • < 0: Failure.

◆ mute()

int io.agora.mediaplayer.IMediaPlayer.mute ( boolean  mute)

Turn mute on or off.

Parameters
muteWhether to mute on
Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

◆ isMuted()

boolean io.agora.mediaplayer.IMediaPlayer.isMuted ( )

Get mute state.

Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError
Parameters
[out]muteWhether is mute on

◆ adjustPlayoutVolume()

int io.agora.mediaplayer.IMediaPlayer.adjustPlayoutVolume ( int  volume)

Adjust playback volume.

Parameters
volumeThe volume value to be adjusted The volume can be adjusted from 0 to 400: 0: mute; 100: original volume; 400: Up to 4 times the original volume (with built-in overflow protection).
Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

◆ getPlayoutVolume()

int io.agora.mediaplayer.IMediaPlayer.getPlayoutVolume ( )

Get the current playback volume.

Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError
Parameters
[out]volume

◆ getPlayPosition()

long io.agora.mediaplayer.IMediaPlayer.getPlayPosition ( )

Gets the current playback position of the media file.

Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

◆ getDuration()

long io.agora.mediaplayer.IMediaPlayer.getDuration ( )

Get media duration.

Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError
Parameters
[out]durationDuration in seconds

◆ getState()

Constants.MediaPlayerState io.agora.mediaplayer.IMediaPlayer.getState ( )

Get player state.

Returns
MediaPlayerState

◆ getStreamCount()

int io.agora.mediaplayer.IMediaPlayer.getStreamCount ( )

Get the number of streams in the media.

Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError
Parameters
[out]count

◆ setView()

int io.agora.mediaplayer.IMediaPlayer.setView ( View  videoView)

Set video rendering view.

Parameters
videoViewview object, windows platform is HWND
Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

◆ setRenderMode()

int io.agora.mediaplayer.IMediaPlayer.setRenderMode ( int  mode)

Set video display mode.

Parameters
modeVideo display mode
Returns
int < 0 on behalf of an error, the value corresponds to one of MEDIA_PLAYER_ERROR

◆ setLoopCount()

int io.agora.mediaplayer.IMediaPlayer.setLoopCount ( int  loopCount)

Sets whether to loop the media file for playback.

Parameters
loopCountthe number of times looping the media file.
  • 0: Play the audio effect once.
  • 1: Play the audio effect twice.
  • -1: Play the audio effect in a loop indefinitely, until stopEffect() or stop() is called.
Returns
  • 0: Success.
  • < 0: Failure.

◆ changePlaybackSpeed()

int io.agora.mediaplayer.IMediaPlayer.changePlaybackSpeed ( Constants.MediaPlayerPlaybackSpeed  speed)

Change playback speed

Parameters
speedthe enum of playback speed
Returns
  • 0: Success.
  • < 0: Failure.

◆ selectAudioTrack()

int io.agora.mediaplayer.IMediaPlayer.selectAudioTrack ( int  index)

Slect playback audio track of the media file

Parameters
indexthe index of the audio track in media file
Returns
  • 0: Success.
  • < 0: Failure.

◆ setPlayerOption()

int io.agora.mediaplayer.IMediaPlayer.setPlayerOption ( String  key,
int  value 
)

change player option before play a file

Parameters
keythe key of the option param
valuethe value of option param
Returns
  • 0: Success.
  • < 0: Failure.

◆ takeScreenshot()

int io.agora.mediaplayer.IMediaPlayer.takeScreenshot ( String  filename)

take screenshot while playing video

Parameters
filenamethe filename of screenshot file
Returns
  • 0: Success.
  • < 0: Failure.

◆ selectInternalSubtitle()

int io.agora.mediaplayer.IMediaPlayer.selectInternalSubtitle ( int  index)

select internal subtitles in video

Parameters
indexthe index of the internal subtitles
Returns
  • 0: Success.
  • < 0: Failure.

◆ setExternalSubtitle()

int io.agora.mediaplayer.IMediaPlayer.setExternalSubtitle ( String  url)

set an external subtitle for video

Parameters
urlThe URL of the subtitle file that you want to load.
Returns
  • 0: Success.
  • < 0: Failure.

◆ adjustPublishSignalVolume()

int io.agora.mediaplayer.IMediaPlayer.adjustPublishSignalVolume ( int  volume)

adjust publish signal volume

Returns
int < 0 on behalf of an error, the value corresponds to one of MEDIA_PLAYER_ERROR

◆ getPublishSignalVolume()

int io.agora.mediaplayer.IMediaPlayer.getPublishSignalVolume ( )

get publish signal volume

Returns
int < 0 on behalf of an error, the value corresponds to one of MEDIA_PLAYER_ERROR

◆ getPlaySrc()

String io.agora.mediaplayer.IMediaPlayer.getPlaySrc ( )

Gets the url of the current play media file for publishing.

Returns
the current play media file for publishing.

◆ destroy()

int io.agora.mediaplayer.IMediaPlayer.destroy ( )
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerPlayerObserver()

int io.agora.mediaplayer.IMediaPlayer.registerPlayerObserver ( IMediaPlayerObserver  playerObserver)

Registers a media player observer.

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

Parameters
playerObserverThe pointer to the IMediaPlayerObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unRegisterPlayerObserver()

int io.agora.mediaplayer.IMediaPlayer.unRegisterPlayerObserver ( IMediaPlayerObserver  playerObserver)

Releases the media player observer.

Parameters
playerObserverThe pointer to the IMediaPlayerObserver object.
Returns
  • 0: Success.
  • < 0: Failure.