StartWhiteboardPushRequest (tencentcloud-sdk-java 3.1.204 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.tiw.v20190919.models.StartWhiteboardPushRequest

public class StartWhiteboardPushRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

StartWhiteboardPushRequest()

Constructors
Constructor and Description
`StartWhiteboardPushRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAutoManageBackup()` Get 对主白板推流任务进行操作时，是否同时同步操作备份任务
`Boolean`	`getAutoRecord()` Get 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
`Long`	`getAutoStopTimeout()` Get 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
`WhiteboardPushBackupParam`	`getBackup()` Get 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
`String`	`getExtraData()` Get 内部参数，不需要关注此参数
`String`	`getPushUserId()` Get 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
`String`	`getPushUserSig()` Get 与PushUserId对应的签名
`Long`	`getRoomId()` Get 需要推流白板的房间号，取值范围: (1, 4294967295)
`Long`	`getSdkAppId()` Get 客户的SdkAppId
`Whiteboard`	`getWhiteboard()` Get 白板参数，例如白板宽高、背景颜色等
`void`	`setAutoManageBackup(Boolean AutoManageBackup)` Set 对主白板推流任务进行操作时，是否同时同步操作备份任务
`void`	`setAutoRecord(Boolean AutoRecord)` Set 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
`void`	`setAutoStopTimeout(Long AutoStopTimeout)` Set 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
`void`	`setBackup(WhiteboardPushBackupParam Backup)` Set 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
`void`	`setExtraData(String ExtraData)` Set 内部参数，不需要关注此参数
`void`	`setPushUserId(String PushUserId)` Set 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
`void`	`setPushUserSig(String PushUserSig)` Set 与PushUserId对应的签名
`void`	`setRoomId(Long RoomId)` Set 需要推流白板的房间号，取值范围: (1, 4294967295)
`void`	`setSdkAppId(Long SdkAppId)` Set 客户的SdkAppId
`void`	`setWhiteboard(Whiteboard Whiteboard)` Set 白板参数，例如白板宽高、背景颜色等
`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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StartWhiteboardPushRequest
```
public StartWhiteboardPushRequest()
```
- Method Detail
  - getSdkAppId
```
public Long getSdkAppId()
```
    Get 客户的SdkAppId
    
    Returns:
    
    SdkAppId 客户的SdkAppId
  - setSdkAppId
```
public void setSdkAppId(Long SdkAppId)
```
    Set 客户的SdkAppId
    
    Parameters:
    
    SdkAppId - 客户的SdkAppId
  - getRoomId
```
public Long getRoomId()
```
    Get 需要推流白板的房间号，取值范围: (1, 4294967295)
    
    Returns:
    
    RoomId 需要推流白板的房间号，取值范围: (1, 4294967295)
  - setRoomId
```
public void setRoomId(Long RoomId)
```
    Set 需要推流白板的房间号，取值范围: (1, 4294967295)
    
    Parameters:
    
    RoomId - 需要推流白板的房间号，取值范围: (1, 4294967295)
  - getPushUserId
```
public String getPushUserId()
```
    Get 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
    
    Returns:
    
    PushUserId 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
  - setPushUserId
```
public void setPushUserId(String PushUserId)
```
    Set 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
    
    Parameters:
    
    PushUserId - 用于白板推流服务进房进行推流的用户ID，该ID必须是一个单独的未在SDK中使用的ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该ID和SDK中使用的ID重复，会导致SDK和白板推流服务互踢，影响正常推流。
  - getPushUserSig
```
public String getPushUserSig()
```
    Get 与PushUserId对应的签名
    
    Returns:
    
    PushUserSig 与PushUserId对应的签名
  - setPushUserSig
```
public void setPushUserSig(String PushUserSig)
```
    Set 与PushUserId对应的签名
    
    Parameters:
    
    PushUserSig - 与PushUserId对应的签名
  - getWhiteboard
```
public Whiteboard getWhiteboard()
```
    Get 白板参数，例如白板宽高、背景颜色等
    
    Returns:
    
    Whiteboard 白板参数，例如白板宽高、背景颜色等
  - setWhiteboard
```
public void setWhiteboard(Whiteboard Whiteboard)
```
    Set 白板参数，例如白板宽高、背景颜色等
    
    Parameters:
    
    Whiteboard - 白板参数，例如白板宽高、背景颜色等
  - getAutoStopTimeout
```
public Long getAutoStopTimeout()
```
    Get 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
    
    Returns:
    
    AutoStopTimeout 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
  - setAutoStopTimeout
```
public void setAutoStopTimeout(Long AutoStopTimeout)
```
    Set 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
    
    Parameters:
    
    AutoStopTimeout - 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
  - getAutoManageBackup
```
public Boolean getAutoManageBackup()
```
    Get 对主白板推流任务进行操作时，是否同时同步操作备份任务
    
    Returns:
    
    AutoManageBackup 对主白板推流任务进行操作时，是否同时同步操作备份任务
  - setAutoManageBackup
```
public void setAutoManageBackup(Boolean AutoManageBackup)
```
    Set 对主白板推流任务进行操作时，是否同时同步操作备份任务
    
    Parameters:
    
    AutoManageBackup - 对主白板推流任务进行操作时，是否同时同步操作备份任务
  - getBackup
```
public WhiteboardPushBackupParam getBackup()
```
    Get 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
    
    Returns:
    
    Backup 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
  - setBackup
```
public void setBackup(WhiteboardPushBackupParam Backup)
```
    Set 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
    
    Parameters:
    
    Backup - 备份白板推流相关参数。指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
  - getAutoRecord
```
public Boolean getAutoRecord()
```
    Get 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
    
    Returns:
    
    AutoRecord 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
  - setAutoRecord
```
public void setAutoRecord(Boolean AutoRecord)
```
    Set 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
    
    Parameters:
    
    AutoRecord - 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
  - getExtraData
```
public String getExtraData()
```
    Get 内部参数，不需要关注此参数
    
    Returns:
    
    ExtraData 内部参数，不需要关注此参数
  - setExtraData
```
public void setExtraData(String ExtraData)
```
    Set 内部参数，不需要关注此参数
    
    Parameters:
    
    ExtraData - 内部参数，不需要关注此参数
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class StartWhiteboardPushRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

StartWhiteboardPushRequest

Method Detail

getSdkAppId

setSdkAppId

getRoomId

setRoomId

getPushUserId

setPushUserId

getPushUserSig

setPushUserSig

getWhiteboard

setWhiteboard

getAutoStopTimeout

setAutoStopTimeout

getAutoManageBackup

setAutoManageBackup

getBackup

setBackup

getAutoRecord

setAutoRecord

getExtraData

setExtraData

toMap