Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

Abstract emit

  • emit(eventName: string, ...args: any[]): any
  • emit callback

    Parameters

    • eventName: string
    • Rest ...args: any[]

    Returns any

Abstract enableAccurateSeek

  • 开启精准 seek 并设置相关属性

    支持版本:2.4.0 及以上。 详情描述:普通 seek 指定的时间戳可能是非 I 帧,进而返回指定时间戳前后的 I 帧,不是很精确。而精准 seek 当指定的时间戳不是 I 帧时,会通过指定时间戳前后的 I 帧去解指定时间戳的那帧数据。 业务场景:适用于用户需要精准 seek 到指定时间戳的场景。 调用时机:必须在加载资源前调用设置,在整个媒体播放器的生命周期内生效。

    Parameters

    • enable: boolean

      是否开启精准 seek

    • config: ZegoAccurateSeekConfig

      精准 seek 的属性设置,只有 enable 为 true 时有效。

    Returns void

Abstract enableAudioData

  • enableAudioData(enable: boolean): void
  • 是否外抛播放的音频数据

    Parameters

    • enable: boolean

      外抛播放的音频数据标记,默认为 false

    Returns void

Abstract enableAux

  • enableAux(enable: boolean): void
  • 是否将播放器的声音混入正在推的流中

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

    Parameters

    • enable: boolean

      是否混音标记,默认为 false

    Returns void

Abstract enableFrequencySpectrumMonitor

  • enableFrequencySpectrumMonitor(enable: boolean, millisecond: number): void
  • 是否开启频谱监听。

    支持版本:2.15.0 及以上。 详情描述:开启或关闭频谱监听。 调用时机:初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。 使用限制:无。 相关回调:开启后可以通过 [onMediaPlayerFrequencySpectrumUpdate] 回调监听声浪更新。

    Parameters

    • enable: boolean

      是否开启监听,true 开启,false 关闭。

    • millisecond: number

      频谱的监听时间周期,单位为毫秒,取值范围 [100, 3000]。

    Returns void

Abstract enableLocalCache

  • enableLocalCache(enable: boolean, cacheDir: string): void
  • 开启本地缓存 http/https 网络资源。

    支持版本:3.12.0 及以上。 详情描述:当播放 http/https 网络资源时,开启本地缓存后,会将网络资源保存到本地,并通过 [onMediaPlayerLocalCache] 将缓存信息回调出来。 调用时机:在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。在 [loadResource] 之后或者播放过程中调用,会在下一次播放生效。 注意事项:只支持 http/https 单文件类型网络资源,如果播放过程中有 [seekTo] 操作,缓存会失败。

    Parameters

    • enable: boolean

      是否开启本地缓存。

    • cacheDir: string

      缓存目录。如果留空会使用 SDK 内部指定的目录。

    Returns void

Abstract enableRepeat

  • enableRepeat(enable: boolean): void
  • 是否重复播放

    Parameters

    • enable: boolean

      重复播放标记,默认为 false

    Returns void

Abstract enableVideoData

  • 是否外抛播放的视频数据

    支持版本:2.1.0 及以上。 详情描述:是否将媒体播放器播放的媒体资源文件的视频数据抛出来。 调用时机:创建 [ZegoMediaPlayer] 实例后。 使用限制:无。 注意事项:当不再需要获取视频帧数据时请再次调用此函数将 handler 置空,以停止视频帧数据回调。

    Parameters

    • enable: boolean

      外抛播放的视频数据标记,默认为 false

    • format: ZegoVideoFrameFormat

      视频数据的视频帧格式

    Returns void

Abstract enableVoiceChanger

  • 开启变声,设置变声的具体参数。

    支持版本:3.15.0 及以上。 详情描述:开启变声,设置变声的具体参数。 调用时机:初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。

    Parameters

    Returns void

Abstract getAudioTrackCount

  • getAudioTrackCount(): number
  • 获取播放文件的音轨个数

    Returns number

    音轨个数

Abstract getCurrentProgress

  • getCurrentProgress(): number
  • 获取当前播放进度

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

    Returns number

    当前播放进度

Abstract getCurrentRenderingProgress

  • getCurrentRenderingProgress(): number
  • 获取当前渲染进度

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

    Returns number

    当前渲染进度

Abstract getCurrentState

  • 获取当前播放状态

    Returns ZegoMediaPlayerState

    当前播放器状态

Abstract getIndex

  • getIndex(): number
  • 获取媒体播放器的序号

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

    Returns number

    媒体播放器索引。

Abstract getPlayVolume

  • getPlayVolume(): number
  • 获取当前媒体播放器本地播放的音量,范围为 0 ~ 200,默认值为 60

    Returns number

    当前音量

Abstract getPublishVolume

  • getPublishVolume(): number
  • 获取当前媒体播放器推流的音量,范围为 0 ~ 200,默认值为 60

    Returns number

    当前音量

Abstract getTotalDuration

  • getTotalDuration(): number
  • 获取媒体资源的总进度

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

    Returns number

    单位为毫秒

Abstract loadResource

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

    支持版本:1.3.4 及以上。 详情描述:加载媒体资源。 业务场景:开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。 调用时机:在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。 相关接口:也可通过 [loadResourceWithPosition] 或 [loadResourceFromMediaData] 函数加载资源。

    Parameters

    • path: string

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

    Returns Promise<ZegoMediaPlayerLoadResourceResult>

    加载媒体资源结果回调。

Abstract muteLocal

  • muteLocal(mute: boolean): void
  • 是否静默本地播放

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

    Parameters

    • mute: boolean

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

    Returns void

Abstract off

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

    Type parameters

    Parameters

    • event: MediaPlayerEventType
    • callback: undefined | ZegoMediaPlayerListener[MediaPlayerEventType]

    Returns any

Abstract on

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

    Type parameters

    Parameters

    • event: MediaPlayerEventType
    • callback: ZegoMediaPlayerListener[MediaPlayerEventType]

    Returns any

Abstract pause

  • pause(): void
  • 暂停播放

    Returns void

Abstract registerAudioDataPlugin

  • registerAudioDataPlugin(plugin: Number): void
  • 注册自定义的媒体播放器音频数据处理插件。

    Parameters

    • plugin: Number

      自定义的媒体播放器音频数据处理插件。

    Returns void

Abstract registerVideoDataPlugin

  • registerVideoDataPlugin(plugin: Number): void
  • 注册自定义的媒体播放器视频数据处理插件。

    Parameters

    • plugin: Number

      自定义的媒体播放器视频数据处理插件。

    Returns void

Abstract resume

  • resume(): void
  • 恢复播放

    Returns void

Abstract seekTo

  • 设置指定的播放进度

    单位为毫秒

    Parameters

    • millisecond: number

      指定的播放进度的时间点

    Returns Promise<ZegoMediaPlayerSeekToResult>

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

Abstract setAudioTrackIndex

  • setAudioTrackIndex(index: number): void
  • 设置播放文件的音轨

    Parameters

    • index: number

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

    Returns void

Abstract setNetworkResourceMaxCache

  • setNetworkResourceMaxCache(time: number, size: number): void
  • 设置网络素材最大的缓存时长和缓存数据大小

    必须在加载资源前调用设置,在整个媒体播放器的生命周期内生效。 time和size不允许同时为 0.。SDK 内部默认time为5000, size为1510241024 byte。time和size中某一个指标先达到设置的值,就会停止缓存。

    Parameters

    • time: number

      缓存最大时长, 单位 ms, SDK 内部默认为5000;有效值为大于等于 2000;如果填 0, 表示不限制。

    • size: number

      缓存最大尺寸, 单位 byte,SDK内部默认size为1510241024 byte;有效值为大于等于 5000000, 如果填 0, 表示不限制。

    Returns void

Abstract setPlayMediaStreamType

  • 设置播放的媒体流类型。

    支持版本:3.10.0 及以上。 详情描述:配置播放的媒体流类型,可以仅播放视频流或者音频流,在播放器生命周期内一直生效。 业务场景:当仅需要播放视频流或者音频流时。 调用时机:在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。 注意事项:播放时改变媒体流类型,将在下一次播放时生效。

    Parameters

    Returns void

Abstract setPlaySpeed

  • setPlaySpeed(speed: number): 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 void

Abstract setPlayVolume

  • setPlayVolume(volume: number): void
  • 设置播放器本地播放音量

    Parameters

    • volume: number

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

    Returns void

Abstract setPlayerView

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

    Parameters

    • view: ZegoView

      视频渲染的画布对象

    Returns void

Abstract setProgressInterval

  • setProgressInterval(millisecond: number): void
  • 设置播放进度回调间隔

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

    Parameters

    • millisecond: number

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

    Returns void

Abstract setPublishVolume

  • setPublishVolume(volume: number): void
  • 设置播放器推流音量

    Parameters

    • volume: number

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

    Returns void

Abstract setVolume

  • setVolume(volume: number): void
  • 设置播放器音量,会同时设置本地播放音量和推流音量

    Parameters

    • volume: number

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

    Returns void

Abstract start

  • start(): void
  • 开始播放

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

    Returns void

Abstract stop

  • stop(): void
  • 停止播放

    Returns void

Abstract unregisterAudioDataPlugin

  • unregisterAudioDataPlugin(): void
  • 注销自定义的媒体播放器音频数据处理插件。

    Returns void

Abstract unregisterVideoDataPlugin

  • unregisterVideoDataPlugin(): void
  • 注销自定义的媒体播放器视频数据处理插件。

    Returns void

Abstract updatePosition

  • updatePosition(position: number[]): void
  • 更新媒体播放器(音频源)位置。

    支持版本:3.6.0 及以上。 详情描述:更新媒体播放器(音频源)位置。。 业务场景:媒体播放器也需要有 3D 空间音效。 调用时机:在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。 使用限制:此接口需要与 RangeAudio/RangeScene 模块配合使用,RangeAudio/RangeScene 模块开启 3D 音效后,此接口才能调用成功。

    Parameters

    • position: number[]

      自身在世界坐标系中的坐标,参数是长度为 3 的 float 数组。

    Returns void

Generated using TypeDoc