com.tencentcloudapi.trtc.v20190722.models

Class StartPublishCdnStreamRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.StartPublishCdnStreamRequest

public class StartPublishCdnStreamRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartPublishCdnStreamRequest()
StartPublishCdnStreamRequest(StartPublishCdnStreamRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
AgentParams	getAgentParams() Get The information of the relaying robot in the room.
McuAudioParams	getAudioParams() Get The audio encoding parameters.
McuFeedBackRoomParams[]	getFeedBackRoomParams() Get The information of the room to which streams are relayed.
McuPublishCdnParam[]	getPublishCdnParams() Get The information of the CDNs to relay to.
McuRecordParams	getRecordParams() Get Relay Recording Parameters.
String	getRoomId() Get The ID of the room whose streams are relayed (the main room).
Long	getRoomIdType() Get The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed.
Long	getSdkAppId() Get The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
McuSeiParams	getSeiParams() Get The stream mixing SEI parameters.
SingleSubscribeParams	getSingleSubscribeParams() Get The information of a single stream relayed.
McuVideoParams	getVideoParams() Get The video encoding parameters for relaying.
Long	getWithTranscoding() Get Whether to transcode the streams.
void	setAgentParams(AgentParams AgentParams) Set The information of the relaying robot in the room.
void	setAudioParams(McuAudioParams AudioParams) Set The audio encoding parameters.
void	setFeedBackRoomParams(McuFeedBackRoomParams[] FeedBackRoomParams) Set The information of the room to which streams are relayed.
void	setPublishCdnParams(McuPublishCdnParam[] PublishCdnParams) Set The information of the CDNs to relay to.
void	setRecordParams(McuRecordParams RecordParams) Set Relay Recording Parameters.
void	setRoomId(String RoomId) Set The ID of the room whose streams are relayed (the main room).
void	setRoomIdType(Long RoomIdType) Set The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed.
void	setSdkAppId(Long SdkAppId) Set The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.
void	setSeiParams(McuSeiParams SeiParams) Set The stream mixing SEI parameters.
void	setSingleSubscribeParams(SingleSubscribeParams SingleSubscribeParams) Set The information of a single stream relayed.
void	setVideoParams(McuVideoParams VideoParams) Set The video encoding parameters for relaying.
void	setWithTranscoding(Long WithTranscoding) Set Whether to transcode the streams.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StartPublishCdnStreamRequest

public StartPublishCdnStreamRequest()

StartPublishCdnStreamRequest

public StartPublishCdnStreamRequest(StartPublishCdnStreamRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getSdkAppId

public Long getSdkAppId()

Get The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.

Returns:

SdkAppId The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.

Parameters:

SdkAppId - The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are relayed.

getRoomId

public String getRoomId()

Get The ID of the room whose streams are relayed (the main room).

Returns:

RoomId The ID of the room whose streams are relayed (the main room).

setRoomId

public void setRoomId(String RoomId)

Set The ID of the room whose streams are relayed (the main room).

Parameters:

RoomId - The ID of the room whose streams are relayed (the main room).

getRoomIdType

public Long getRoomIdType()

Get The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.

Returns:

RoomIdType The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.

setRoomIdType

public void setRoomIdType(Long RoomIdType)

Set The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.

Parameters:

RoomIdType - The type of the `RoomId` parameter, which must be the same as the ID type of the room whose streams are relayed. 0: integer; 1: string.

getAgentParams

public AgentParams getAgentParams()

Get The information of the relaying robot in the room.

Returns:

AgentParams The information of the relaying robot in the room.

setAgentParams

public void setAgentParams(AgentParams AgentParams)

Set The information of the relaying robot in the room.

Parameters:

AgentParams - The information of the relaying robot in the room.

getWithTranscoding

public Long getWithTranscoding()

Get Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.

Returns:

WithTranscoding Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.

setWithTranscoding

public void setWithTranscoding(Long WithTranscoding)

Set Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.

Parameters:

WithTranscoding - Whether to transcode the streams. `0`: No. `1`: Yes. This parameter determines whether transcoding fees are charged. If it is `0`, streams will only be relayed, and no transcoding fees will be incurred. If it is `1`, streams will be transcoded before being relayed, and transcoding fees will be incurred.

getAudioParams

public McuAudioParams getAudioParams()

Get The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.

Returns:

AudioParams The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.

setAudioParams

public void setAudioParams(McuAudioParams AudioParams)

Set The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.

Parameters:

AudioParams - The audio encoding parameters. Because audio is always transcoded (no fees are incurred), this parameter is required when you start a relay task.

getVideoParams

public McuVideoParams getVideoParams()

Get The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.

Returns:

VideoParams The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.

setVideoParams

public void setVideoParams(McuVideoParams VideoParams)

Set The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.

Parameters:

VideoParams - The video encoding parameters for relaying. If you do not pass this parameter, only audio will be relayed.

getSingleSubscribeParams

public SingleSubscribeParams getSingleSubscribeParams()

Get The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.

Returns:

SingleSubscribeParams The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.

setSingleSubscribeParams

public void setSingleSubscribeParams(SingleSubscribeParams SingleSubscribeParams)

Set The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.

Parameters:

SingleSubscribeParams - The information of a single stream relayed. When you relay a single stream, set `WithTranscoding` to 0.

getPublishCdnParams

public McuPublishCdnParam[] getPublishCdnParams()

Get The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.

Returns:

PublishCdnParams The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.

setPublishCdnParams

public void setPublishCdnParams(McuPublishCdnParam[] PublishCdnParams)

Set The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.

Parameters:

PublishCdnParams - The information of the CDNs to relay to. You need to specify at least one between this parameter and `FeedBackRoomParams.N`.

getSeiParams

public McuSeiParams getSeiParams()

Get The stream mixing SEI parameters.

Returns:

SeiParams The stream mixing SEI parameters.

setSeiParams

public void setSeiParams(McuSeiParams SeiParams)

Set The stream mixing SEI parameters.

Parameters:

SeiParams - The stream mixing SEI parameters.

getFeedBackRoomParams

public McuFeedBackRoomParams[] getFeedBackRoomParams()

Get The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.

Returns:

FeedBackRoomParams The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.

setFeedBackRoomParams

public void setFeedBackRoomParams(McuFeedBackRoomParams[] FeedBackRoomParams)

Set The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.

Parameters:

FeedBackRoomParams - The information of the room to which streams are relayed. Between this parameter and `PublishCdnParams`, you must specify at least one. Please note that relaying to a TRTC room is only supported in some SDK versions. For details, please contact technical support.

getRecordParams

public McuRecordParams getRecordParams()

Get Relay Recording Parameters. Example value:{"UniRecord":1,"RecordKey": "test_recore_key_a"}

Returns:

RecordParams Relay Recording Parameters. Example value:{"UniRecord":1,"RecordKey": "test_recore_key_a"}

setRecordParams

public void setRecordParams(McuRecordParams RecordParams)

Set Relay Recording Parameters. Example value:{"UniRecord":1,"RecordKey": "test_recore_key_a"}

Parameters:

RecordParams - Relay Recording Parameters. Example value:{"UniRecord":1,"RecordKey": "test_recore_key_a"}

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.