Class ZegoMediaPlayer

Available since: 2.20.0 Description: 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]. Restrictions: The interface call takes effect only when the media player ends playing.

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

Available since: 2.15.0 Description: 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]. Restrictions: None. Related APIs: After it is turned on, user can use the [onMediaPlayerFrequencySpectrumUpdate] callback to monitor frequency spectrum updates.

Available since: 3.10.0 Description: 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.12.0 Description: 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: 2.15.0 Description: 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]. Restrictions: None. Related callbacks: After it is turned on, user can use the [onMediaPlayerSoundLevelUpdate] callback to monitor sound level updates.

Available since: 3.14.0 Description: 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.15.0 Description: 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].

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

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

Description: Get media player index. When to call: It can be called after [createMediaPlayer]. Restrictions: None.

Available since: 3.6.0 Description: 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]. Restrictions: None.

Available since: 3.12.0 Description: 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.

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

Available: since 1.3.4 Description: 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.

Available: since 3.3.0 Description: 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.

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

Unit is millisecond

Available since: 2.20.0 Description: 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]. Restrictions: None.

Available since: 3.1.0 Description: 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 Description: 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.8.0 Description: 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]. Restrictions: Called before the corresponding network resource is loaded.

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.

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.

Available since: 3.10.0 Description: 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: 2.12.0 Description: Set the playback speed of the player. When to call: You should load resource before invoking this function. Restrictions: None. Related APIs: Resources can be loaded through the [loadResource] function.

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

You need to load resources before playing

Only in the case of calling [setPlayerCanvas] to set the display controls and the playback state, can the screenshot be taken normally Note: This function is only available in ZegoExpressVideo SDK!

Available since: 3.6.0 Description: 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]. 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.