媒体流附属信息分发

  • React Native

更新时间不可用

registerMediaMetadataObserver

注册媒体 metadata 观测器用于接收或发送 metadata。

TypeScript
abstract registerMediaMetadataObserver(
    observer: IMetadataObserver,
    type: MetadataType
  ): number;

你需要自行实现 IMetadataObserver 类并在本方法中指定 metadata 类型。本方法允许你为视频流添加同步的 metadata,用于多样化的直播互动,如发送购物链接、电子优惠券和在线测试。

注: 请在 joinChannel 前调用该方法。

参数

参数名描述
observer

metadata 观测器。详见 IMetadataObserver。

type

metadata 类型。目前仅支持 VideoMetadata。详见 MetadataType。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

sendMetaData

发送媒体附属信息。

TypeScript
abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number;

如果成功发送了媒体附属信息,接收端会收到 onMetadataReceived 回调。

请确保 metadata 大小不超过 setMaxMetadataSize 中设置的最大值。如果超过该值,SDK 会截除超出部分。

参数

参数名描述
metadata

媒体附属信息。详见 Metadata。

sourceType

视频源的类型,详见 VideoSourceType。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setMaxMetadataSize

设置媒体附属信息的最大大小。

TypeScript
abstract setMaxMetadataSize(size: number): number;

调用 registerMediaMetadataObserver 后,你可以调用本方法来设置媒体附属信息的最大大小。

参数

参数名描述
size

媒体附属信息的最大大小。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

unregisterMediaMetadataObserver

取消注册媒体 metadata 观测器。

TypeScript
abstract unregisterMediaMetadataObserver(
    observer: IMetadataObserver,
    type: MetadataType
  ): number;

参数

参数名描述
observer

metadata 观测器,详见 IMetadataObserver。

type

metadata 类型。目前仅支持 VideoMetadata。详见 MetadataType。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0:方法调用成功。
  • < 0:方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onMetadataReceived

接收端已收到 metadata。

TypeScript
onMetadataReceived?(metadata: Metadata): void;

参数

参数名描述
metadata

接收到的 metadata,详见 Metadata。

表格内容超出当前宽度,可横向滚动查看更多列。

所属接口类