Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.mediaplayer.internal.IMediaPlayerKit Interface Reference
Inheritance diagram for io.agora.mediaplayer.internal.IMediaPlayerKit:
io.agora.mediaplayer.internal.AgoraMediaPlayer

Public Member Functions

int open (String src, long startPos)
 Open media file. More...
 
int play ()
 Play. More...
 
int pause ()
 pause More...
 
int stop ()
 stop More...
 
int seek (long pos)
 Play to a specified position. More...
 
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 ()
 Get the current playback progress. More...
 
long getDuration ()
 Get media duration. More...
 
int 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)
 
MediaStreamInfo getStreamInfo (int index)
 
int destroy ()
 
int registerPlayerObserver (MediaPlayerObserver playerObserver)
 
int unRegisterPlayerObserver (MediaPlayerObserver playerObserver)
 
int registerVideoFrameObserver (VideoFrameObserver observer)
 
int registerAudioFrameObserver (AudioFrameObserver observer)
 
void unRegisterVideoFrameObserver (VideoFrameObserver observer)
 
void unRegisterAudioFrameObserver (AudioFrameObserver observer)
 
int setLogFilter (int filter)
 
int setLogFile (String filePath)
 
int changePlaybackSpeed (MediaPlayerPlaybackSpeed speed)
 
int selectAudioTrack (int index)
 
int setPlayerOption (String key, int value)
 

Member Function Documentation

◆ open()

int io.agora.mediaplayer.internal.IMediaPlayerKit.open ( String  src,
long  startPos 
)

Open media file.

Parameters
startPosSet the starting position for playback, in seconds
Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ play()

int io.agora.mediaplayer.internal.IMediaPlayerKit.play ( )

Play.

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ pause()

int io.agora.mediaplayer.internal.IMediaPlayerKit.pause ( )

pause

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ stop()

int io.agora.mediaplayer.internal.IMediaPlayerKit.stop ( )

stop

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ seek()

int io.agora.mediaplayer.internal.IMediaPlayerKit.seek ( long  pos)

Play to a specified position.

Parameters
posThe position to play, in seconds
Returns
int <= 0 On behalf of an error, the value corresponds to one of MediaPlayerError

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ mute()

int io.agora.mediaplayer.internal.IMediaPlayerKit.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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ isMuted()

boolean io.agora.mediaplayer.internal.IMediaPlayerKit.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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ adjustPlayoutVolume()

int io.agora.mediaplayer.internal.IMediaPlayerKit.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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ getPlayoutVolume()

int io.agora.mediaplayer.internal.IMediaPlayerKit.getPlayoutVolume ( )

Get the current playback volume.

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ getPlayPosition()

long io.agora.mediaplayer.internal.IMediaPlayerKit.getPlayPosition ( )

Get the current playback progress.

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ getDuration()

long io.agora.mediaplayer.internal.IMediaPlayerKit.getDuration ( )

Get media duration.

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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ getState()

int io.agora.mediaplayer.internal.IMediaPlayerKit.getState ( )

Get player state.

Returns
MediaPlayerState

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ getStreamCount()

int io.agora.mediaplayer.internal.IMediaPlayerKit.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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.

◆ setView()

int io.agora.mediaplayer.internal.IMediaPlayerKit.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

Implemented in io.agora.mediaplayer.internal.AgoraMediaPlayer.