Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZegoMediaDataPublisher

Hierarchy

Index

Methods

Abstract addMediaFilePath

  • addMediaFilePath(path: string, isClear: boolean): void
  • 添加媒体文件到推流队列中。目前仅支持 mp4 / m4a / aac 文件,且需要做特殊转换。

    支持版本:2.17.0 及以上。 详情描述:添加媒体文件到推流队列中。目前仅支持 mp4 / m4a / aac 文件,且需要做特殊转换。 业务场景:常用于服务器端推流的场景,例如 AI 课堂。 调用时机:在调用 [createMediaDataPublisher] 函数创建媒体数据推流器后。 注意事项:mp4 文件格式必须满足以下几点:视频编码为 H.264,不能包含 B 帧,仅包含 I 帧和 P 帧,I 帧间隔为 2s,即单个 GOP 值为 2s;视频的帧率、码率、分辨率与推流前通过 [setVideoConfig] 设置的帧率、码率、分辨率保持一致;音频编码为 MPEG-4 AAC。

    Parameters

    • path: string

      媒体文件的本地绝对路径。

    • isClear: boolean

      是否清空推流队列。

    Returns void

Abstract emit

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

    Parameters

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

    Returns any

Abstract getCurrentDuration

  • getCurrentDuration(): number
  • 获取当前文件的播放进度。

    支持版本:2.17.0 及以上。 详情描述:获取当前文件的播放进度,单位毫秒。 调用时机:[onMediaDataPublisherFileDataBegin] 回调之后。

    Returns number

    当前文件的播放进度。

Abstract getIndex

  • getIndex(): number
  • 获取媒体推流器的推流通道号。

    支持版本:3.4.0 及以上。 详情描述:获取媒体推流器的推流通道号。

    Returns number

Abstract getTotalDuration

  • getTotalDuration(): number
  • 获取当前文件的总时长。

    支持版本:2.17.0 及以上。 详情描述:获取当前文件的总时长,单位毫秒。 调用时机:[onMediaDataPublisherFileDataBegin] 回调之后。

    Returns number

    当前文件的总时长。

Abstract off

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

    Type parameters

    Parameters

    • event: MediaDataPublisherEventType
    • callback: undefined | ZegoMediaDataPublisherListener[MediaDataPublisherEventType]

    Returns any

Abstract on

  • on<MediaDataPublisherEventType>(event: MediaDataPublisherEventType, callback: ZegoMediaDataPublisherListener[MediaDataPublisherEventType]): any
  • register callback

    Type parameters

    Parameters

    • event: MediaDataPublisherEventType
    • callback: ZegoMediaDataPublisherListener[MediaDataPublisherEventType]

    Returns any

Abstract reset

  • reset(): void
  • 清除此媒体推流器中的所有状态,以便下次推流时重新开始。

    支持版本:2.17.0 及以上。 详情描述:当需要重新推流,且不需要从之前的推流队列中继续推时,可调用此函数重置媒体推流器的状态。 注意事项:当开发者调用了 [logoutRoom] 之后,会自动重置状态。

    Returns void

Abstract seekTo

  • seekTo(millisecond: number): void
  • 指定当前视频文件推流发送的时间起始点。

    支持版本:2.17.0 及以上。 详情描述:指定当前视频文件推流发送的时间起始点。 调用时机:在 [OnMediaDataPublisherFileOpen] 与 [OnMediaDataPublisherFileClose] 之间任意时间点调用都可。如:可以在 [OnMediaDataPublisherFileOpen] 回调中直接调用此函数。

    Parameters

    • millisecond: number

      开始推流的时间戳(相对于当前正在推流文件的时间戳,起始值为 0),单位:毫秒。

    Returns void

Abstract setVideoSendDelayTime

  • setVideoSendDelayTime(delayTime: number): void
  • 设置推迟视频播放时间。

    支持版本:2.17.0 及以上。 详情描述:当设置了此值后,在推流视频文件时,SDK 会固定地将视频延迟至设置的时间值才开始发送。 业务场景:主要用于修正推流时出现的固定的音画不同步现象。 调用时机:在调用 [createMediaDataPublisher] 函数创建媒体数据推流器后。

    Parameters

    • delayTime: number

      推迟视频播放时间。是否必填:是。取值范围:[0, 100] ms。

    Returns void

Generated using TypeDoc