com.tencentcloudapi.trtc.v20190722.models

Class StartStreamIngestRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.StartStreamIngestRequest

public class StartStreamIngestRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartStreamIngestRequest()
StartStreamIngestRequest(StartStreamIngestRequest 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
AudioEncodeParams	getAudioEncodeParams() Deprecated.
Boolean	getAutoPush() Get 开启自动旁路推流，请确认控制台已经开启该功能。
Long	getMaxDuration() Get 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。
String	getPrivateMapKey() Get TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
Long	getRepeatNum() Get 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration
String	getRoomId() Get TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
Long	getRoomIdType() Get TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）
Long	getSdkAppId() Get TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。
Long	getSeekSecond() Get 指定视频从某个秒时间戳播放
String[]	getSourceUrl() Deprecated.
String	getStreamUrl() Get 源流URL【必填】。如果是视频流，分辨率请保持不变。
String	getUserId() Get 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。
String	getUserSig() Get 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
VideoEncodeParams	getVideoEncodeParams() Deprecated.
Long	getVolume() Get 音量，取值范围[0, 100]，默认100，表示原音量。
void	setAudioEncodeParams(AudioEncodeParams AudioEncodeParams) Deprecated.
void	setAutoPush(Boolean AutoPush) Set 开启自动旁路推流，请确认控制台已经开启该功能。
void	setMaxDuration(Long MaxDuration) Set 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。
void	setPrivateMapKey(String PrivateMapKey) Set TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
void	setRepeatNum(Long RepeatNum) Set 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration
void	setRoomId(String RoomId) Set TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
void	setRoomIdType(Long RoomIdType) Set TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）
void	setSdkAppId(Long SdkAppId) Set TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。
void	setSeekSecond(Long SeekSecond) Set 指定视频从某个秒时间戳播放
void	setSourceUrl(String[] SourceUrl) Deprecated.
void	setStreamUrl(String StreamUrl) Set 源流URL【必填】。如果是视频流，分辨率请保持不变。
void	setUserId(String UserId) Set 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。
void	setUserSig(String UserSig) Set 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
void	setVideoEncodeParams(VideoEncodeParams VideoEncodeParams) Deprecated.
void	setVolume(Long Volume) Set 音量，取值范围[0, 100]，默认100，表示原音量。
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

StartStreamIngestRequest

public StartStreamIngestRequest()

StartStreamIngestRequest

public StartStreamIngestRequest(StartStreamIngestRequest 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 TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。

Returns:

SdkAppId TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。

Parameters:

SdkAppId - TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和TRTC的房间所对应的SdkAppId相同。

getRoomId

public String getRoomId()

Get TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。

Returns:

RoomId TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。

setRoomId

public void setRoomId(String RoomId)

Set TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。

Parameters:

RoomId - TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。

getRoomIdType

public Long getRoomIdType()

Get TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）

Returns:

RoomIdType TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）

setRoomIdType

public void setRoomIdType(Long RoomIdType)

Set TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）

Parameters:

RoomIdType - TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId（默认）

getUserId

public String getUserId()

Get 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。

Returns:

UserId 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。

setUserId

public void setUserId(String UserId)

Set 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。

Parameters:

UserId - 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。

getUserSig

public String getUserSig()

Get 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。

Returns:

UserSig 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。

setUserSig

public void setUserSig(String UserSig)

Set 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。

Parameters:

UserSig - 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。

getStreamUrl

public String getStreamUrl()

Get 源流URL【必填】。如果是视频流，分辨率请保持不变。

Returns:

StreamUrl 源流URL【必填】。如果是视频流，分辨率请保持不变。

setStreamUrl

public void setStreamUrl(String StreamUrl)

Set 源流URL【必填】。如果是视频流，分辨率请保持不变。

Parameters:

StreamUrl - 源流URL【必填】。如果是视频流，分辨率请保持不变。

getPrivateMapKey

public String getPrivateMapKey()

Get TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。

Returns:

PrivateMapKey TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。

setPrivateMapKey

public void setPrivateMapKey(String PrivateMapKey)

Set TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。

Parameters:

PrivateMapKey - TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。

getVideoEncodeParams

@Deprecated
public VideoEncodeParams getVideoEncodeParams()

Deprecated.

Get 【本字段已废弃】视频编码参数。可选，如果不填，保持原始流的参数。

Returns:

VideoEncodeParams 【本字段已废弃】视频编码参数。可选，如果不填，保持原始流的参数。

setVideoEncodeParams

@Deprecated
public void setVideoEncodeParams(VideoEncodeParams VideoEncodeParams)

Deprecated.

Set 【本字段已废弃】视频编码参数。可选，如果不填，保持原始流的参数。

Parameters:

VideoEncodeParams - 【本字段已废弃】视频编码参数。可选，如果不填，保持原始流的参数。

getAudioEncodeParams

@Deprecated
public AudioEncodeParams getAudioEncodeParams()

Deprecated.

Get 【本字段已废弃】音频编码参数。可选，如果不填，保持原始流的参数。

Returns:

AudioEncodeParams 【本字段已废弃】音频编码参数。可选，如果不填，保持原始流的参数。

setAudioEncodeParams

@Deprecated
public void setAudioEncodeParams(AudioEncodeParams AudioEncodeParams)

Deprecated.

Set 【本字段已废弃】音频编码参数。可选，如果不填，保持原始流的参数。

Parameters:

AudioEncodeParams - 【本字段已废弃】音频编码参数。可选，如果不填，保持原始流的参数。

getSourceUrl

@Deprecated
public String[] getSourceUrl()

Deprecated.

Get 【本字段已废弃，请使用 StreamUrl 字段】源流URL，支持一个地址。

Returns:

SourceUrl 【本字段已废弃，请使用 StreamUrl 字段】源流URL，支持一个地址。

setSourceUrl

@Deprecated
public void setSourceUrl(String[] SourceUrl)

Deprecated.

Set 【本字段已废弃，请使用 StreamUrl 字段】源流URL，支持一个地址。

Parameters:

SourceUrl - 【本字段已废弃，请使用 StreamUrl 字段】源流URL，支持一个地址。

getSeekSecond

public Long getSeekSecond()

Get 指定视频从某个秒时间戳播放

Returns:

SeekSecond 指定视频从某个秒时间戳播放

setSeekSecond

public void setSeekSecond(Long SeekSecond)

Set 指定视频从某个秒时间戳播放

Parameters:

SeekSecond - 指定视频从某个秒时间戳播放

getAutoPush

public Boolean getAutoPush()

Get 开启自动旁路推流，请确认控制台已经开启该功能。

Returns:

AutoPush 开启自动旁路推流，请确认控制台已经开启该功能。

setAutoPush

public void setAutoPush(Boolean AutoPush)

Set 开启自动旁路推流，请确认控制台已经开启该功能。

Parameters:

AutoPush - 开启自动旁路推流，请确认控制台已经开启该功能。

getRepeatNum

public Long getRepeatNum()

Get 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration

Returns:

RepeatNum 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration

setRepeatNum

public void setRepeatNum(Long RepeatNum)

Set 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration

Parameters:

RepeatNum - 循环播放次数, 取值范围[-1, 1000], 默认1次。 - 0 无效值 - -1 循环播放, 需要主动调用停止接口或设置MaxDuration

getMaxDuration

public Long getMaxDuration()

Get 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。

Returns:

MaxDuration 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。

setMaxDuration

public void setMaxDuration(Long MaxDuration)

Set 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。

Parameters:

MaxDuration - 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。

getVolume

public Long getVolume()

Get 音量，取值范围[0, 100]，默认100，表示原音量。

Returns:

Volume 音量，取值范围[0, 100]，默认100，表示原音量。

setVolume

public void setVolume(Long Volume)

Set 音量，取值范围[0, 100]，默认100，表示原音量。

Parameters:

Volume - 音量，取值范围[0, 100]，默认100，表示原音量。

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.