| Class | Description |
|---|---|
| App |
app详细信息
|
| App.ScopeEnum |
RTC覆盖范围。 取值如下: - DOMESTIC:国内范围。 - OVERSEA:海外范围。 - GLOBAL:全球范围。
|
| AppAuth |
鉴权配置
|
| AppAuthReq |
修改app鉴权请求
|
| AppAutoRecordMode |
app自动录制模式
|
| AppAutoRecordMode.ModeEnum |
录制模式。 - AUTO_RECORD_OFF:关闭自动录制。 - AUTO_INDIVIDUAL_RECORD:开启单流自动录制,此时record_rule_id必须非空。
|
| AppCallbacks |
app回调配置
|
| AppCallbackUrl |
回调配置
|
| AppCallbackUrl.NotifyEventSubscriptionEnum |
Gets or Sets notifyEventSubscription
|
| AppCallbackUrlReq |
修改app回调请求
|
| AppReq |
创建应用请求体
|
| AppState |
app状态信息
|
| AppState.StateEnum |
状态 - ACTIVATION:开启 - DEACTIVATION:停用 - ARREARS:欠费 - DELETED:已删除
|
| AutoRecordModeReq |
配置app自动录制模式请求
|
| AutoRecordModeReq.ModeEnum |
录制模式。 - AUTO_RECORD_OFF:关闭自动录制。 - AUTO_INDIVIDUAL_RECORD:开启单流自动录制,此时record_rule_id必须非空。
|
| CreateAppRequest |
Request Object
|
| CreateAppResponse |
Response Object
|
| CreateIndividualStreamJobRequest |
Request Object
|
| CreateIndividualStreamJobResponse |
Response Object
|
| CreateIndividualStreamJobResponse.SelectStreamTypeEnum |
指定窗口拉取的分辨率档位。 - LD - SD - HD - FHD 缺省为FHD。
|
| CreateIndividualStreamJobResponse.StateEnum |
任务状态。 - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
|
| CreateIndividualStreamJobResponse.StopReasonEnum |
任务结束原因
|
| CreateIndividualStreamJobResponse.VideoTypeEnum |
标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。 - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流 默认为CAMERASTREAM。
|
| CreateMixJobRequest |
Request Object
|
| CreateMixJobResponse |
Response Object
|
| CreateMixJobResponse.StateEnum |
任务状态。 - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
|
| CreateMixJobResponse.StopReasonEnum |
任务结束原因
|
| CreateRecordRuleRequest |
Request Object
|
| CreateRecordRuleResponse |
Response Object
|
| CreateRecordRuleResponse.RecordFormatsEnum |
Gets or Sets recordFormats
|
| DeleteAppRequest |
Request Object
|
| DeleteAppResponse |
Response Object
|
| DeleteRecordRuleRequest |
Request Object
|
| DeleteRecordRuleResponse |
Response Object
|
| HLSRecordConfig |
HLSRecordConfig
|
| IndividualStreamJobReq |
单流任务请求,转推和录制至少选一个
|
| IndividualStreamJobReq.SelectStreamTypeEnum |
指定窗口拉取的分辨率档位。 - LD - SD - HD - FHD 缺省为FHD。
|
| IndividualStreamJobReq.VideoTypeEnum |
标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。 - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流 默认为CAMERASTREAM。
|
| ListAppsRequest |
Request Object
|
| ListAppsRequest.StateEnum |
应用的状态: - ACTIVATION:应用开启 - DEACTIVATION:应用停用 - ARREARS:应用欠费
|
| ListAppsResponse |
Response Object
|
| ListRecordRulesRequest |
Request Object
|
| ListRecordRulesResponse |
Response Object
|
| MixJobReq |
合流任务参数,转推和录制至少选一个
|
| MixLayoutPane |
录制视频混流参数。 用法如下: 如果某窗格需要展示某个固定用户的视频: 例如:{ \"id\": 1, \"user_id\": \"user001\",
\"video_type\": \"CAMERASTREAM\" } 如果某窗格需要展示某个固定用户的共享屏幕: 例如:{ \"id\": 1,
\"user_id\": \"user001\", \"video_type\": \"SCREENSTREAM\" }
如果某窗格需要展示共享桌面,不特定用户: 例如:{ \"id\": 1, \"video_type\": \"SCREENSTREAM\"}
|
| MixLayoutPane.CropModeEnum |
裁剪模式,自定义布局场景下填写本字段,支持两种模式: - KEEP_RATIO_PADDING :保持比例留边。 - KEEP_RATIO_CROP :保持比例裁剪。
|
| MixLayoutPane.VideoTypeEnum |
标识视频流的类型,可选摄像头流或者屏幕分享流。 - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流 默认为CAMERASTREAM。
|
| MixParam |
合流参数 - 纯音频录制 encode_template 填 audio_only,音频合流会动态选择最大三方的声音。 layout_template、layout_panes 以及其他视频相关参数都不填,填就忽略。 -
音视频录制(包括共享桌面) encode_template 非 audio_only,layout_template必须非空。 音频合流会动态选择最大三方的声音
|
| MixParam.EncodeTemplateEnum |
输出编码模板名称 - 1920x1080_30_4620:输出流是1080p,帧率30,码率4.62Mbps - 1920x1080_15_3460:输出流是1080p,帧率15,码率3.46Mbps -
1280x720_30_3420:输出流是720p,帧率30,码率3.42Mbps - 1280x720_15_2260:输出流是720p,帧率15,码率2.26Mbps
|
| MixUserBackgroundImage |
指定用户的背景图,优先级大于default_user_background_image
|
| MP4RecordConfig |
MP4RecordConfig
|
| PublishParam |
转推参数
|
| RecordObsFileAddr |
RecordObsFileAddr
|
| RecordObsFileAddr.LocationEnum |
OBS Bucket所在RegionID
|
| RecordParam |
录制参数
|
| RecordRule |
创建状态回调请求体
|
| RecordRule.RecordFormatsEnum |
Gets or Sets recordFormats
|
| RecordRuleReq |
修改录制规则
|
| RecordRuleReq.RecordFormatsEnum |
Gets or Sets recordFormats
|
| ShowAppRequest |
Request Object
|
| ShowAppResponse |
Response Object
|
| ShowAppResponse.ScopeEnum |
RTC覆盖范围。 取值如下: - DOMESTIC:国内范围。 - OVERSEA:海外范围。 - GLOBAL:全球范围。
|
| ShowAutoRecordRequest |
Request Object
|
| ShowAutoRecordResponse |
Response Object
|
| ShowIndividualStreamJobRequest |
Request Object
|
| ShowIndividualStreamJobResponse |
Response Object
|
| ShowIndividualStreamJobResponse.SelectStreamTypeEnum |
指定窗口拉取的分辨率档位。 - LD - SD - HD - FHD 缺省为FHD。
|
| ShowIndividualStreamJobResponse.StateEnum |
任务状态。 - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
|
| ShowIndividualStreamJobResponse.StopReasonEnum |
任务结束原因
|
| ShowIndividualStreamJobResponse.VideoTypeEnum |
标识视频流的类型,可选摄像头流或者屏幕分享流,未填写表示不录制视频。 - CAMERASTREAM:摄像头视频流 - SCREENSTREAM:屏幕分享视频流 默认为CAMERASTREAM。
|
| ShowMixJobRequest |
Request Object
|
| ShowMixJobResponse |
Response Object
|
| ShowMixJobResponse.StateEnum |
任务状态。 - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
|
| ShowMixJobResponse.StopReasonEnum |
任务结束原因
|
| ShowRecordCallbackRequest |
Request Object
|
| ShowRecordCallbackResponse |
Response Object
|
| ShowRecordRuleRequest |
Request Object
|
| ShowRecordRuleResponse |
Response Object
|
| ShowRecordRuleResponse.RecordFormatsEnum |
Gets or Sets recordFormats
|
| ShowUrlAuthRequest |
Request Object
|
| ShowUrlAuthResponse |
Response Object
|
| StartAppRequest |
Request Object
|
| StartAppResponse |
Response Object
|
| StopAppRequest |
Request Object
|
| StopAppResponse |
Response Object
|
| StopIndividualStreamJobRequest |
Request Object
|
| StopIndividualStreamJobResponse |
Response Object
|
| StopMixJobRequest |
Request Object
|
| StopMixJobResponse |
Response Object
|
| UpdateAutoRecordRequest |
Request Object
|
| UpdateAutoRecordResponse |
Response Object
|
| UpdateMixJobReq |
合流任务参数
|
| UpdateMixJobRequest |
Request Object
|
| UpdateMixJobResponse |
Response Object
|
| UpdateMixJobResponse.StateEnum |
任务状态。 - INIT:任务正在初始化 - RUNNING:任务正在运行 - STOPPED:任务已停止
|
| UpdateMixJobResponse.StopReasonEnum |
任务结束原因
|
| UpdateMixParam |
可修改的合流参数
|
| UpdateRecordCallbackRequest |
Request Object
|
| UpdateRecordCallbackResponse |
Response Object
|
| UpdateRecordRuleRequest |
Request Object
|
| UpdateRecordRuleResponse |
Response Object
|
| UpdateRecordRuleResponse.RecordFormatsEnum |
Gets or Sets recordFormats
|
| UpdateUrlAuthRequest |
Request Object
|
| UpdateUrlAuthResponse |
Response Object
|
Copyright © 2021. All rights reserved.