logo
On this page

ZegoMediaPlayer

ZegoMediaPlayer

Declared in ZegoMediaPlayer.java

Methods

setEventHandler

setEventHandler
public void setEventHandler(IZegoMediaPlayerEventHandler handler)
Set event notification callback handler of the media player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
handlerIZegoMediaPlayerEventHandlerEvent callback handler for media player

Details

Listen to the event notification callback of the media player. Use Cases: You can change the media player UI widget according to the related event callback.

  • When to call: After the [ZegoMediaPlayer] instance created.
  • Caution: Calling this function will overwrite the callback set by the last call to this function.
  • Available since: 2.1.0
  • Restrictions: None.

setVideoHandler

setVideoHandler
public void setVideoHandler(IZegoMediaPlayerVideoHandler handler, ZegoVideoFrameFormat format)
Set video data callback handler of the media player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
handlerIZegoMediaPlayerVideoHandlerVideo data callback handler for media player
formatZegoVideoFrameFormatVideo frame format for video data

Details

By setting this callback, the video data of the media resource file played by the media player can be called back.

  • When to call: After the [ZegoMediaPlayer] instance created.
  • Caution: When you no longer need to get the video frame data, please call this function again to clear the handler to stop the video frame data callback.
  • Available since: 2.1.0
  • Restrictions: None.

setAudioHandler

setAudioHandler
public void setAudioHandler(IZegoMediaPlayerAudioHandler handler)
Set audio data callback handler of the media player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
handlerIZegoMediaPlayerAudioHandlerAudio data callback handler for media player

Details

By setting this callback, the audio data of the media resource file played by the media player can be called back.

  • When to call: After the [ZegoMediaPlayer] instance created.
  • Caution: When you no longer need to get the audio data, please call this function again to clear the handler to stop the audio data callback.
  • Available since: 2.1.0
  • Restrictions: None.

setBlockDataHandler

setBlockDataHandler
public void setBlockDataHandler(IZegoMediaPlayerBlockDataHandler handler, int blockSize)
Set the media resource block data callback handler of the media player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
handlerIZegoMediaPlayerBlockDataHandlerThe media resource block data callback handler of the media player.
blockSizeintThe size of the encrypted data block. The bufferSize in the OnBlockData callback is an integer multiple of blockSize.

Details

This callback can be set to listen to and decrypt the media resource block data for playing the user's own ciphertext media resources.

  • When to call: After the [ZegoMediaPlayer] instance created, before playing media resources.
  • Caution: When it is no longer necessary to listen to the callback for data decryption, please call this function again to clear the handler.
  • Available since: 3.4.0
  • Restrictions: None.

loadResource

loadResource
public void loadResource(String path, IZegoMediaPlayerLoadResourceCallback callback)
Load local or network media resource.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
pathStringThe absolute resource path or the URL of the network resource and cannot be null or "". Android can set this path string with Uri.
callbackIZegoMediaPlayerLoadResourceCallbackNotification of resource loading results

Details

Load media resources. Use case: Developers can load the absolute path to the local resource or the URL of the network resource incoming.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related APIs: Resources can be loaded through the [loadResourceWithPosition] or [loadResourceFromMediaData] function.
  • Caution: If the mediaplayer has already loaded resources or is in the process of playing, please first call the [stop] interface to halt the playback, and then proceed to call the interface to load the media resources; failure to do so will result in an unsuccessful load.

Return

Callback result of loading media resource.

loadResourceWithPosition

loadResourceWithPosition
public void loadResourceWithPosition(String path, long startPosition, IZegoMediaPlayerLoadResourceCallback callback)
Load local or network media resource and specify the start position.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
pathStringThe absolute resource path or the URL of the network resource and cannot be null or "". Android can set this path string with Uri.
startPositionlongThe progress at which the playback started.
callbackIZegoMediaPlayerLoadResourceCallbackNotification of resource loading results

Details

Load media resources, and specify the progress, in milliseconds, at which playback begins. Use case: Developers can load the absolute path to the local resource or the URL of the network resource incoming.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related APIs: Resources can be loaded through the [loadResource] or [loadResourceFromMediaData] function.
  • Caution: 1.When [startPosition] exceeds the total playing time, it will start playing from the beginning. 2.If the mediaplayer has already loaded resources or is in the process of playing, please first call the [stop] interface to halt the playback, and then proceed to call the interface to load the media resources; failure to do so will result in an unsuccessful load.

Return

Callback result of loading media resource.

loadResourceFromMediaData

loadResourceFromMediaData
public void loadResourceFromMediaData(byte[] mediaData, long startPosition, IZegoMediaPlayerLoadResourceCallback callback)
Load binary audio resource.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
mediaDatabyte[]Binary audio data.
startPositionlongPosition of starting playback, in milliseconds.
callbackIZegoMediaPlayerLoadResourceCallbackNotification of resource loading results.

Details

Load binary audio data. Use case: Developers do not want to cache the audio data locally, and directly transfer the audio binary data to the media player, directly load and play the audio.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related APIs: Resources can be loaded through the [loadResource] or [loadResourceWithPosition] function.
  • Caution: 1.When [startPosition] exceeds the total playing time, it will start playing from the beginning. 2.If the mediaplayer has already loaded resources or is in the process of playing, please first call the [stop] interface to halt the playback, and then proceed to call the interface to load the media resources; failure to do so will result in an unsuccessful load.

Return

Callback result of loading media resource.

loadCopyrightedMusicResourceWithPosition

loadCopyrightedMusicResourceWithPosition
public void loadCopyrightedMusicResourceWithPosition(String resourceID, long startPosition, IZegoMediaPlayerLoadResourceCallback callback)
Load copyrighted music resource.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
resourceIDStringThe resource ID obtained from the copyrighted music module.
startPositionlongThe progress at which the playback started.
callbackIZegoMediaPlayerLoadResourceCallbackNotification of resource loading results

Details

Load media resources, and specify the progress, in milliseconds, at which playback begins. Use case: Developers can load the resource ID of copyrighted music.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Caution: 1.When [startPosition] exceeds the total playing time, it will start playing from the beginning. 2.If the mediaplayer has already loaded resources or is in the process of playing, please first call the [stop] interface to halt the playback, and then proceed to call the interface to load the media resources; failure to do so will result in an unsuccessful load.

Return

Callback result of loading media resource.

loadResourceWithConfig

loadResourceWithConfig
public void loadResourceWithConfig(ZegoMediaPlayerResource resource, IZegoMediaPlayerLoadResourceCallback callback)
Load local or network media resource with config.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
resourceZegoMediaPlayerResourceMultimedia resources that need to be loaded.
callbackIZegoMediaPlayerLoadResourceCallbackNotification of resource loading results

Details

Load media resources. Use case: Developers can load the absolute path to the local resource or the URL of the network resource incoming.

  • When to call: Called after the engine [createEngine] has been initialized and the media player [createMediaPlayer] has been created.
  • Related APIs: Support for loading resources through the [loadResourceWithPosition] or [loadResourceFromMediaData] interface.
  • Caution: If the mediaplayer has already loaded resources or is in the process of playing, please first call the [stop] interface to halt the playback, and then proceed to call the interface to load the media resources; failure to do so will result in an unsuccessful load.

Return

Callback result of loading media resource.

start

start
public void start()
Start playing.
Declared in ZegoMediaPlayer.java

You need to load resources before playing

stop

stop
public void stop()
Stop playing.
Declared in ZegoMediaPlayer.java

pause

pause
public void pause()
Pause playing.
Declared in ZegoMediaPlayer.java

resume

resume
public void resume()
Resume playing.
Declared in ZegoMediaPlayer.java

seekTo

seekTo
public void seekTo(long millisecond, IZegoMediaPlayerSeekToCallback callback)
Set the specified playback progress.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
millisecondlongPoint in time of specified playback progress
callbackIZegoMediaPlayerSeekToCallbackThe result notification of set the specified playback progress

Details

Unit is millisecond

Return

The result notification of set the specified playback progress

enableRepeat

enableRepeat
public void enableRepeat(boolean enable)
Whether to repeat playback.
Declared in ZegoMediaPlayer.java
NameTypeDescription
enablebooleanrepeat playback flag. The default is false.

setPlaySpeed

setPlaySpeed
public void setPlaySpeed(float speed)
Set the speed of play.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
speedfloatThe speed of play. The default is 1.0.
Versions 2.12.0 to 3.15.1: The range is 0.5 ~ 4.0.
Versions 3.16.0 and above: The range is 0.3 ~ 4.0.

Details

Set the playback speed of the player.

  • When to call: You should load resource before invoking this function.
  • Related APIs: Resources can be loaded through the [loadResource] function.
  • Available since: 2.12.0
  • Restrictions: None.

enableAux

enableAux
public void enableAux(boolean enable)
Whether to mix the player's sound into the stream being published.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanAux audio flag. The default is false.

Details

This interface will only mix the media player sound into the main channel

muteLocal

muteLocal
public void muteLocal(boolean mute)
Whether to play locally silently.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
mutebooleanMute local audio flag, The default is false.

Details

If [enableAux] switch is turned on, there is still sound in the publishing stream. The default is false.

setPlayerCanvas

setPlayerCanvas
public void setPlayerCanvas(ZegoCanvas canvas)
Set the view of the player playing video.
Declared in ZegoMediaPlayer.java
NameTypeDescription
canvasZegoCanvasVideo rendered canvas object

setVolume

setVolume
public void setVolume(int volume)
Set mediaplayer volume. Both the local play volume and the publish volume are set.
Declared in ZegoMediaPlayer.java
NameTypeDescription
volumeintThe range is 0 ~ 200. The default is 60.

setPlayVolume

setPlayVolume
public void setPlayVolume(int volume)
Set mediaplayer local playback volume.
Declared in ZegoMediaPlayer.java
NameTypeDescription
volumeintThe range is 0 ~ 200. The default is 60.

setPublishVolume

setPublishVolume
public void setPublishVolume(int volume)
Set mediaplayer publish volume.
Declared in ZegoMediaPlayer.java
NameTypeDescription
volumeintThe range is 0 ~ 200. The default is 60.

setProgressInterval

setProgressInterval
public void setProgressInterval(long millisecond)
Set playback progress callback interval.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
millisecondlongInterval of playback progress callback in milliseconds

Details

This function can control the callback frequency of [onMediaPlayerPlayingProgress]. When the callback interval is set to 0, the callback is stopped. The default callback interval is 1s This callback are not returned exactly at the set callback interval, but rather at the frequency at which the audio or video frames are processed to determine whether the callback is needed to call

getPlayVolume

getPlayVolume
public int getPlayVolume()
Gets the current local playback volume of the mediaplayer, the range is 0 ~ 200, with the default value of 60.
Declared in ZegoMediaPlayer.java

current volume

getPublishVolume

getPublishVolume
public int getPublishVolume()
Gets the current publish volume of the mediaplayer, the range is 0 ~ 200, with the default value of 60.
Declared in ZegoMediaPlayer.java

current volume

getTotalDuration

getTotalDuration
public long getTotalDuration()
Get the total progress of your media resources.
Declared in ZegoMediaPlayer.java

You should load resource before invoking this function, otherwise the return value is 0

Unit is millisecond

getCurrentProgress

getCurrentProgress
public long getCurrentProgress()
Get current playing progress.
Declared in ZegoMediaPlayer.java

You should load resource before invoking this function, otherwise the return value is 0

current progress

getCurrentRenderingProgress

getCurrentRenderingProgress
public long getCurrentRenderingProgress()
Get current rendering progress.
Declared in ZegoMediaPlayer.java

You should load resource before invoking this function, otherwise the return value is 0

current rendering progress

getAudioTrackCount

getAudioTrackCount
public int getAudioTrackCount()
Get the number of audio tracks of the playback file.
Declared in ZegoMediaPlayer.java

Number of audio tracks

setAudioTrackIndex

setAudioTrackIndex
public void setAudioTrackIndex(int index)
Set the audio track of the playback file.
Declared in ZegoMediaPlayer.java
NameTypeDescription
indexintAudio track index, the number of audio tracks can be obtained through the [getAudioTrackCount] function.

setAudioTrackMode

setAudioTrackMode
public void setAudioTrackMode(ZegoMediaPlayerAudioTrackMode mode)
Set the audio track mode of the player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
modeZegoMediaPlayerAudioTrackModeAudio track mode.

Details

Set the audio track mode of the player. Use case: Under the real-time chorus (KTV), call the interface enable multi-track mode, call the interface [setAudioTrackIndex] to specify the original track to play, call interface [setAudioTrackPublishIndex] specified need publish of accompaniment tracks.

  • When to call: The call takes effect before [start] starts playing
  • Related APIs: Call [setAudioTrackIndex] to specified the play track of media file and call [setAudioTrackPublishIndex] to specified the publish track of media file.
  • Caution: When multi-track mode is enabled, the resource consumption of the hardware device is increased.
  • Available since: 3.1.0

setAudioTrackPublishIndex

setAudioTrackPublishIndex
public void setAudioTrackPublishIndex(int index)
Set the audio track for the media file to be publish.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
indexintAudio track index, the number of audio tracks can be obtained through the [getAudioTrackCount] function.

Details

Set the audio track for the media file to be publish.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related APIs: The number of audio tracks can be obtained through the [getAudioTrackCount] function.
  • Caution: This call takes effect only after multitrack mode is enabled by calling the interface [setAudioTrackMode].
  • Available since: 3.1.0

enableVoiceChanger

enableVoiceChanger
public void enableVoiceChanger(ZegoMediaPlayerAudioChannel audioChannel, boolean enable, ZegoVoiceChangerParam param)
Enable voice changer, set up the specific voice changer parameters.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
audioChannelZegoMediaPlayerAudioChannelThe audio channel to be voice changed
enablebooleanWhether enable voice changer or not. True - enabled, false - disabled, default value is false.
paramZegoVoiceChangerParamVoice changer parameters

Details

Enable voice changer, set up the specific voice changer parameters.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 3.15.0

getCurrentState

getCurrentState
public ZegoMediaPlayerState getCurrentState()
Get the current playback status.
Declared in ZegoMediaPlayer.java

current state

getIndex

getIndex
public int getIndex()
Get media player index.
Declared in ZegoMediaPlayer.java

Get media player index.

  • When to call: It can be called after [createMediaPlayer].
  • Restrictions: None.

Media player index.

takeSnapshot

takeSnapshot
public void takeSnapshot(IZegoMediaPlayerTakeSnapshotCallback callback)
Take a screenshot of the current playing screen of the media player.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
callbackIZegoMediaPlayerTakeSnapshotCallbackThe callback of the screenshot of the media player playing screen

Details

Only in the case of calling [setPlayerCanvas] to set the display controls and the playback state, can the screenshot be taken normally

enableAccurateSeek

enableAccurateSeek
public void enableAccurateSeek(boolean enable, ZegoAccurateSeekConfig config)
Enable accurate seek and set relevant attributes.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable accurate seek
configZegoAccurateSeekConfigThe property setting of accurate seek, only valid when enable is true.

Details

The timestamp specified by normal seek may not an I frame, and then returns the I frame near the specified timestamp, which is not so accurate. But the accurate seek, when the specified timestamp is not an I frame, it will use the I frame near the specified timestamp to decode the frame of the specified timestamp.

  • Use cases: When user needs to seek to the specified timestamp accurately.
  • When to call: The setting must be called before [loadResource], and it will take effect during the entire life cycle of the media player.
  • Available since: 2.4.0

setNetWorkResourceMaxCache

setNetWorkResourceMaxCache
public void setNetWorkResourceMaxCache(int time, int size)
Set the maximum cache duration and cache data size of web materials.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
timeintThe maximum length of the cache time, in ms, the SDK internal default is 5000; the effective value is greater than or equal to 2000; if you fill in 0, it means no limit.
sizeintThe maximum size of the cache, the unit is byte, the internal default size of the SDK is 1510241024 byte; the effective value is greater than or equal to 5000000, if you fill in 0, it means no limit.

Details

The setting must be called before loading the resource, and it will take effect during the entire life cycle of the media player. Time and size are not allowed to be 0 at the same time. The SDK internal default time is 5000, and the size is 1510241024 byte.When one of time and size reaches the set value first, the cache will stop. When loading resources with a non-empty onlineResourceCachePath, the cache is controlled by maxCachePendingLength. This configuration is invalid.

getNetWorkResourceCache

getNetWorkResourceCache
public ZegoNetWorkResourceCache getNetWorkResourceCache()
Get the playable duration and size of the cached data of the current network material cache queue
Declared in ZegoMediaPlayer.java

Returns the current cached information, including the length of time the data can be played and the size of the cached data.

setNetWorkBufferThreshold

setNetWorkBufferThreshold
public void setNetWorkBufferThreshold(int threshold)
Use this interface to set the cache threshold that the media player needs to resume playback. The SDK default value is 5000ms,The valid value is greater than or equal to 1000ms
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
thresholdintThreshold that needs to be reached to resume playback, unit ms.

Details

The setting must be called before loading the resource, and it will take effect during the entire life cycle of the media player. When the network status is poor and the media player has finished playing the cached network resources, it will stop playing, and notify the user through the ZegoMediaPlayerNetworkEvent.BUFFER_BEGIN state of the callback interface onMediaPlayerNetworkEvent that the network resources are being recached. Only when the cached network resources are greater than the set threshold, the media player will automatically resume playback at the original paused position, and notify the user through the ZegoMediaPlayerNetworkEvent.BUFFER_ENDED of the callback interface onMediaPlayerNetworkEvent that the user has cached the network resources The threshold was reached and playback resumed.

enableSoundLevelMonitor

enableSoundLevelMonitor
public void enableSoundLevelMonitor(boolean enable, int millisecond)
Whether to enable sound level monitoring.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable monitoring, true is enabled, false is disabled.
millisecondintMonitoring time period of the sound level, in milliseconds, has a value range of [100, 3000].

Details

Whether to enable sound level monitoring.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related callbacks: After it is turned on, user can use the [onMediaPlayerSoundLevelUpdate] callback to monitor sound level updates.
  • Available since: 2.15.0
  • Restrictions: None.

enableFrequencySpectrumMonitor

enableFrequencySpectrumMonitor
public void enableFrequencySpectrumMonitor(boolean enable, int millisecond)
Whether to enable frequency spectrum monitoring.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable monitoring, true is enabled, false is disabled.
millisecondintMonitoring time period of the frequency spectrum, in milliseconds, has a value range of [10, 3000]. Note that on v3.19.0 and older version, the value range is [100, 3000].

Details

Whether to enable frequency spectrum monitoring.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Related APIs: After it is turned on, user can use the [onMediaPlayerFrequencySpectrumUpdate] callback to monitor frequency spectrum updates.
  • Available since: 2.15.0
  • Restrictions: None.

setActiveAudioChannel

setActiveAudioChannel
public void setActiveAudioChannel(ZegoMediaPlayerAudioChannel audioChannel)
Set the playback channel.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
audioChannelZegoMediaPlayerAudioChannelPlayback channel, the default is ZegoMediaPlayerAudioChannelAll.

Details

Set the playback channel.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 2.20.0
  • Restrictions: None.

clearView

clearView
public void clearView()
Clears the last frame of the playback control that remains on the control after playback ends.
Declared in ZegoMediaPlayer.java

Clears the last frame of the playback control that remains on the control after playback ends.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 2.20.0
  • Restrictions: The interface call takes effect only when the media player ends playing.

getMediaInfo

getMediaInfo
public ZegoMediaPlayerMediaInfo getMediaInfo()
Get meida information such as video resolution from media file.
Declared in ZegoMediaPlayer.java

Get meida information such as video resolution from media file.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 3.6.0
  • Restrictions: None.

updatePosition

updatePosition
public void updatePosition(float[] position)
Update the position of the media player (audio source).
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
positionfloat[]The unit vector of the front axis of its own coordinate system. The parameter is a float array with a length of 3.

Details

Update the position of the media player (audio source).

  • Use cases: The media player also needs to have 3D spatial sound.
  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 3.6.0
  • Restrictions: This interface needs to be used in conjunction with the RangeAudio/RangeScene module. This interface can only be called successfully after the RangeAudio/RangeScene module enables 3D sound effects.

setHttpHeader

setHttpHeader
public void setHttpHeader(HashMap<String, String> headers)
Set http headers.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
headersHashMap<String, String>Headers info.

Details

Call this function to set the http headers of the http network resource.

  • Use cases: When the network resource needs to set special header information.
  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 3.8.0
  • Restrictions: Called before the corresponding network resource is loaded.

setPlayMediaStreamType

setPlayMediaStreamType
public void setPlayMediaStreamType(ZegoMediaStreamType streamType)
Set play media stream type.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
streamTypeZegoMediaStreamTypeStream type.

Details

Configure the media stream type to be played. You can only play video streams or audio streams. This will take effect during the life cycle of the media player.

  • Use cases: When only the video stream or audio stream needs to be played.
  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Caution: Changing the media stream type during playing will take effect in the next playing.
  • Available since: 3.10.0

enableLiveAudioEffect

enableLiveAudioEffect
public void enableLiveAudioEffect(boolean enable, ZegoLiveAudioEffectMode mode)
Enable live audio effect.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable live audio effect.
modeZegoLiveAudioEffectModeLive audio effect mode.

Details

When the live audio effect is turned on, the spatial sense is enhanced and the instrument sounds become more prominent, without any increase in delay.

  • Use cases: It is commonly used in voice chat rooms and karaoke scenarios to enhance the live audio effects of the accompaniment.
  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Caution: To enhance the live audio effect experience, it is recommended to configure dual-channel stereo encoding. Developers can achieve this configuration by using the [setAudioCaptureStereoMode] method. Failure to configure dual-channel stereo encoding may significantly diminish the effects of certain songs, as the left and right channel effects may cancel each other out when synthesizing mono audio, resulting in less noticeable effects.
  • Available since: 3.10.0

enableLocalCache

enableLocalCache
public void enableLocalCache(boolean enable, String cacheDir)
Enable local caching of http/https network resources.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable local caching.
cacheDirStringCache dir. If left blank, the directory specified internally by SDK will be used.

Details

When playing http/https network resources, when the local cache is enabled, the network resources will be saved locally and the cache information will be called back through [onMediaPlayerLocalCache].

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer]. Called after [loadResource] or during playback, it will take effect next playback.
  • Caution: Only http/https single file type network resources are supported. If there is a [seek] operation during playback, the cache will fail.
  • Available since: 3.12.0

enableViewMirror

enableViewMirror
public void enableViewMirror(boolean enable)
Enable the view mirror.
Declared in ZegoMediaPlayer.java

Parameters

NameTypeDescription
enablebooleanWhether to enable view mirror.

Details

Enable view mirror.

  • When to call: It can be called after the engine by [createEngine] has been initialized and the media player has been created by [createMediaPlayer].
  • Available since: 3.14.0

getPlaybackStatistics

getPlaybackStatistics
public ZegoMediaPlayerStatisticsInfo getPlaybackStatistics()
Get playback statistics.
Declared in ZegoMediaPlayer.java

Get current playback statistics to monitor whether decoding and rendering anomalies occur in the player.

  • Use cases: Typically used in cloud-based media player scenarios.
  • When to call: Invoke after the [loadResource] callback succeeds.
  • Available since: 3.12.0

setVoiceChangerParam

setVoiceChangerParam
deprecated
public void setVoiceChangerParam(ZegoMediaPlayerAudioChannel audioChannel, ZegoVoiceChangerParam param)
[Deprecated] Setting up the specific voice changer parameters.
Declared in ZegoMediaPlayer.java
NameTypeDescription
audioChannelZegoMediaPlayerAudioChannelThe audio channel to be voice changed
paramZegoVoiceChangerParamVoice changer parameters
Deprecated
Deprecated since 3.15.0, please use [enableVoiceChanger] instead.

Previous

zegomediadatapublisherconfig

Next

zegomediaplayermediainfo

On this page

Back to top