文档中心
视频通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

Cocos Creator SDK API Reference

概览 agora AgoraRtcEvents

LiveTranscoding 定义。

Hierarchy

  • LiveTranscoding

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • Default value width: number = 360
    • Default value height: number = 640
    • Default value videoBitrate: number = 400
    • Default value videoFramerate: number = 15
    • Default value lowLatency: boolean = false
    • Default value videoGop: number = 30
    • Default value videoCodecProfile: VIDEO_CODEC_PROFILE_TYPE = VIDEO_CODEC_PROFILE_TYPE.VIDEO_CODEC_PROFILE_HIGH
    • Default value backgroundColor: number = 0
    • Default value userCount: number = 0
    • transcodingUsers: TranscodingUser[]
    • transcodingExtraInfo: string
    • metadata: string
    • watermark: RtcImage
    • backgroundImage: RtcImage
    • Default value audioSampleRate: AUDIO_SAMPLE_RATE_TYPE = AUDIO_SAMPLE_RATE_TYPE.AUDIO_SAMPLE_RATE_48000
    • Default value audioBitrate: number = 48
    • Default value audioChannels: 1 | 2 | 3 | 4 | 5 = 1
    • Default value audioCodecProfile: AUDIO_CODEC_PROFILE_TYPE = AUDIO_CODEC_PROFILE_TYPE.AUDIO_CODEC_PROFILE_LC_AAC
    • advancedFeatures: LiveStreamAdvancedFeature
    • Default value advancedFeatureCount: number = 0

    Returns LiveTranscoding

Properties

advancedFeatureCount

advancedFeatureCount: number

开启的高级功能数量。默认值为 0。

advancedFeatures

advancedFeatures: LiveStreamAdvancedFeature

转码推流的高级功能。详见 LiveStreamAdvancedFeature。

audioBitrate

audioBitrate: number

用于旁路推流的输出音频的码率。单位为 Kbps，默认值为 48，最大值为 128。

audioChannels

audioChannels: 1 | 2 | 3 | 4 | 5

用于旁路推流的输出音频的声道数，默认值为 1。取值范围为 [1,5] 中的整型，建议取 1 或 2：

  • 1: 单声道（默认）
  • 2: 双声道
  • 3: 三声道
  • 4: 四声道
  • 5: 五声道

audioCodecProfile

audioCodecProfile: AUDIO_CODEC_PROFILE_TYPE

用于旁路推流的输出视频的编码规格: AUDIO_CODEC_PROFILE_TYPE 。

audioSampleRate

audioSampleRate: AUDIO_SAMPLE_RATE_TYPE

自定义音频采样率: AUDIO_SAMPLE_RATE_TYPE 。

backgroundColor

backgroundColor: number

用于旁路直播的输出视频的背景色，格式为 RGB 定义下的十六进制整数，不要带 # 号，如 0xFFB6C1 表示浅粉色。默认 0x000000，黑色。

backgroundImage

backgroundImage: RtcImage

用于旁路直播的输出视频上的背景图片。添加后所有旁路直播的观众都可以看到背景图片。背景图片的定义详见 RtcImage。

height

height: number

推流视频的总高度，默认值 640，单位为像素。

  • 如果推视频流，height 值不得低于 64，否则声网会调整为 64。
  • 如果推音频流，请将 width 和 height 设为 0。

lowLatency

lowLatency: boolean
deprecated
  • true: 低延时，不保证画质；
  • false:（默认值）高延时，保证画质。

metadata

metadata: string
deprecated

发送给 CDN 客户端的 metadata。

transcodingExtraInfo

transcodingExtraInfo: string

预留参数：用户自定义的发送到旁路推流客户端的信息。用于填充 H.264/H.265 视频中 SEI 帧内容。长度限制 4096 字节。关于 SEI 的详细信息， 详见 SEI 帧相关问题。

transcodingUsers

transcodingUsers: TranscodingUser[]

TranscodingUser

userCount

userCount: number

参与合图的用户数量，默认 0。

videoBitrate

videoBitrate: number

用于旁路推流的输出视频的码率。 单位为 Kbps。 400 Kbps 为默认值。用户可以根据 Video Profile 参考表中的码率值进行设置；如果设置的码率超出合理 范围，声网服务器会在合理区间内自动调整码率值。

videoCodecProfile

videoCodecProfile: VIDEO_CODEC_PROFILE_TYPE

用于旁路推流的输出视频的编码规格: VIDEO_CODEC_PROFILE_TYPE 。

note

如果你将这个参数设为其他值，声网会将其设为默认值 100。

videoFramerate

videoFramerate: number

用于旁路推流的输出视频的帧率。取值范围是 (0,30]，单位为 fps。15 fps 为默认值。

note

声网会将所有高于 30 fps 的帧率统一设为 30 fps。

videoGop

videoGop: number

用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 帧。

watermark

watermark: RtcImage

用于旁路直播的输出视频上的水印图片。添加后所有旁路直播的观众都可以看到水印。水印图片的定义详见 RtcImage。必须为 PNG 格式。

width

width: number

推流视频的总宽度，默认值 360，单位为像素。

  • 如果推视频流，width 值不得低于 64，否则声网会调整为 64。
  • 如果推音频流，请将 width 和 height 设为 0。