Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoMediaPlayer

Hierarchy

Index

Methods

Methods

Abstract enableAux

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

  • 是否将播放器的声音混入正在推的流中

    此接口仅会将媒体播放器声音混到主通道中

    Parameters

    • enable: boolean

      是否混音标记，默认为 false

    Returns Promise<void>

Abstract enableRepeat

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

  • 是否重复播放

    Parameters

    • enable: boolean

      重复播放标记，默认为 false

    Returns Promise<void>

Abstract getAudioTrackCount

  • getAudioTrackCount(): Promise<number>

  • 获取播放文件的音轨个数

    Returns Promise<number>

    音轨个数

Abstract getCurrentProgress

  • getCurrentProgress(): Promise<number>

  • 获取当前播放进度

    必须在加载资源完成后才能调用，否则返回值为 0

    Returns Promise<number>

    当前播放进度

Abstract getCurrentRenderingProgress

  • getCurrentRenderingProgress(): Promise<number>

  • 获取当前渲染进度

    必须在加载资源完成后才能调用，否则返回值为 0

    Returns Promise<number>

    当前渲染进度

Abstract getCurrentState

  • 获取当前播放状态

    Returns Promise<ZegoMediaPlayerState>

    当前播放器状态

Abstract getIndex

  • getIndex(): number

  • 获取媒体播放器的序号

    详情描述：获取媒体播放器索引。 调用时机：在 [createMediaPlayer] 之后可调用。 使用限制：无。

    Returns number

    媒体播放器索引。

Abstract getPlayVolume

  • getPlayVolume(): Promise<number>

  • 获取当前媒体播放器本地播放的音量，范围为 0 ~ 200，默认值为 60

    Returns Promise<number>

    当前音量

Abstract getPublishVolume

  • getPublishVolume(): Promise<number>

  • 获取当前媒体播放器推流的音量，范围为 0 ~ 200，默认值为 60

    Returns Promise<number>

    当前音量

Abstract getTotalDuration

  • getTotalDuration(): Promise<number>

  • 获取媒体资源的总进度

    必须在加载资源完成后才能调用，否则返回值为 0

    Returns Promise<number>

    单位为毫秒

Abstract loadResource

  • 加载本地或者网络媒体资源。

    支持版本：1.3.4 及以上。 详情描述：加载媒体资源。 业务场景：开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。 相关接口：也可通过 [loadResourceWithPosition] 或 [loadResourceFromMediaData] 函数加载资源。 注意事项：如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

    Parameters

    • path: string

      本地资源路径或网络资源的 URL，不能传入 null 或 ""。Android 可通过 Uri 方式进行传参。

    Returns Promise<ZegoMediaPlayerLoadResourceResult>

    加载媒体资源结果回调。

Abstract loadResourceWithConfig

  • 加载本地或者网络媒体资源，带配置参数。

    支持版本：3.3.0 及以上。 详情描述：加载媒体资源。 业务场景：开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后调用。 相关接口：支持通过 [loadResourceWithPosition] 或 [loadResourceFromMediaData] 接口加载资源。 注意事项：如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

    Parameters

    Returns Promise<ZegoMediaPlayerLoadResourceResult>

    加载媒体资源结果回调。

Abstract muteLocal

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

  • 是否静默本地播放

    若开启了混音入流则推的流中仍然有声音，默认为 false。

    Parameters

    • mute: boolean

      本地静音标记，默认为 false。

    Returns Promise<void>

Abstract off

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

  • 注销监听媒体播放器事件回调

    Type parameters

    Parameters

    • event: MediaPlayerEventType

      事件类型。

    • callback: undefined | ZegoMediaPlayerListener[MediaPlayerEventType]

      事件回调。

    Returns void

Abstract on

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

  • 注册监听媒体播放器事件回调

    Type parameters

    Parameters

    • event: MediaPlayerEventType

      事件类型。

    • callback: ZegoMediaPlayerListener[MediaPlayerEventType]

      事件回调。

    Returns void

Abstract pause

  • pause(): Promise<void>

  • 暂停播放

    Returns Promise<void>

Abstract resume

  • resume(): Promise<void>

  • 恢复播放

    Returns Promise<void>

Abstract seekTo

  • 设置指定的播放进度

    单位为毫秒

    Parameters

    • millisecond: number

      指定的播放进度的时间点

    Returns Promise<ZegoMediaPlayerSeekToResult>

    设置指定的播放进度的结果通知

Abstract setAudioTrackIndex

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

  • 设置播放文件的音轨

    Parameters

    • index: number

      音轨序号，可以通过 [getAudioTrackCount] 获取音轨个数

    Returns Promise<void>

Abstract setPlaySpeed

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

  • 设置播放倍速。

    支持版本：2.12.0 及以上。 详情描述：设置播放器的播放倍速。 调用时机：必须在加载资源完成后才能调用。 使用限制：无。 相关接口：可通过 [loadResource] 函数加载资源。

    Parameters

    • speed: number

      播放速度。默认为 1.0。 2.12.0 至 3.15.1 版本：范围为 0.5 ~ 4.0。 3.16.0 及以上版本：范围为 0.3 ~ 4.0。

    Returns Promise<void>

Abstract setPlayVolume

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

  • 设置播放器本地播放音量

    Parameters

    • volume: number

      范围为 0 ~ 200，默认为 60。

    Returns Promise<void>

Abstract setPlayerView

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

  • 设置播放器播放视频的视图 注意：此函数仅在 ZegoExpressVideo SDK 中有效！

    Parameters

    • view: ZegoView

      视频渲染的画布对象

    Returns Promise<void>

Abstract setProgressInterval

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

  • 设置播放进度回调间隔

    可通过此函数控制 [onMediaPlayerPlayingProgress] 的回调频率，当设置回调间隔为 0 时，停止回调。默认回调间隔为 1s 回调不会严格按照设定的回调间隔值返回，而是以处理音频帧或者视频帧的频率来判断是否需要回调

    Parameters

    • millisecond: number

      播放进度回调间隔时间，单位为毫秒

    Returns Promise<void>

Abstract setPublishVolume

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

  • 设置播放器推流音量

    Parameters

    • volume: number

      范围为 0 ~ 200，默认为 60。

    Returns Promise<void>

Abstract setVolume

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

  • 设置播放器音量，会同时设置本地播放音量和推流音量

    Parameters

    • volume: number

      范围为 0 ~ 200，默认为 60。

    Returns Promise<void>

Abstract start

  • start(): Promise<void>

  • 开始播放

    必须在加载资源完成后才能调用

    Returns Promise<void>

Abstract stop

  • stop(): Promise<void>

  • 停止播放

    Returns Promise<void>

Generated using TypeDoc