Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoMediaPlayerImpl

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • index: number

    Returns ZegoMediaPlayerImpl

Properties

Private _index

_index: number

Methods

enableAux

  • enableAux(enable: boolean): Promise<void>

  • Parameters

    • enable: boolean

    Returns Promise<void>

enableRepeat

  • enableRepeat(enable: boolean): Promise<void>

getAudioTrackCount

  • getAudioTrackCount(): Promise<number>

getCurrentProgress

  • getCurrentProgress(): Promise<number>

Abstract getCurrentRenderingProgress

  • getCurrentRenderingProgress(): Promise<number>

  • Get current rendering progress.

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

    Returns Promise<number>

    current rendering progress

getCurrentState

getIndex

  • getIndex(): number

getPlayVolume

  • getPlayVolume(): Promise<number>

getPublishVolume

  • getPublishVolume(): Promise<number>

getTotalDuration

  • getTotalDuration(): Promise<number>

loadResource

Abstract loadResourceWithConfig

  • Load local or network media resource with config.

    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.

    Parameters

    Returns Promise<ZegoMediaPlayerLoadResourceResult>

    Callback result of loading media resource.

muteLocal

  • muteLocal(mute: boolean): Promise<void>

  • Parameters

    • mute: boolean

    Returns Promise<void>

off

  • off<MediaPlayerEventType>(event: MediaPlayerEventType, callback?: ZegoMediaPlayerListener[MediaPlayerEventType]): void

  • Type parameters

    Parameters

    • event: MediaPlayerEventType
    • Optional callback: ZegoMediaPlayerListener[MediaPlayerEventType]

    Returns void

on

  • on<MediaPlayerEventType>(event: MediaPlayerEventType, callback: ZegoMediaPlayerListener[MediaPlayerEventType]): void

  • Type parameters

    Parameters

    • event: MediaPlayerEventType
    • callback: ZegoMediaPlayerListener[MediaPlayerEventType]

    Returns void

pause

  • pause(): Promise<void>

  • Returns Promise<void>

resume

  • resume(): Promise<void>

seekTo

setAudioTrackIndex

  • setAudioTrackIndex(index: number): Promise<void>

setPlaySpeed

  • setPlaySpeed(speed: number): Promise<void>

setPlayVolume

  • setPlayVolume(volume: number): Promise<void>

setPlayerView

  • setPlayerView(view: ZegoView): Promise<void>

setProgressInterval

  • setProgressInterval(millisecond: number): Promise<void>

setPublishVolume

  • setPublishVolume(volume: number): Promise<void>

setVolume

  • setVolume(volume: number): Promise<void>

  • Parameters

    • volume: number

    Returns Promise<void>

start

  • start(): Promise<void>

  • Returns Promise<void>

stop

  • stop(): Promise<void>

  • Returns Promise<void>

Generated using TypeDoc