Package com.tencentcloudapi.tiw.v20190919.models

Class StartWhiteboardPushRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Boolean getAutoManageBackup()
      Get 对主白板推流任务进行操作时，是否同时同步操作备份任务
      Boolean getAutoPublish()
      Get 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。
      Boolean getAutoRecord()
      Get 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
      Long getAutoStopTimeout()
      Get 自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。 当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。
      WhiteboardPushBackupParam getBackup()
      Get 备份白板推流相关参数。 指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。
      String getExtraData()
      Get 内部参数，不需要关注此参数
      AuthParam getIMAuthParam()
      Get IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。
      String getPrivateMapKey()
      Get TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。
      String getPushUserId()
      Get 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。
      String getPushUserSig()
      Get 与PushUserId对应的IM签名(usersig)。
      Long getRoomId()
      Get 需要推流的白板房间号，取值范围: (1, 4294967295)。 1.
      Long getSdkAppId()
      Get 客户的SdkAppId
      AuthParam getTRTCAuthParam()
      Get TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
      String getTRTCEnterRoomMode()
      Get 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。
      Long getTRTCRoomId()
      Get TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。
      String getTRTCRoomIdStr()
      Get TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
      String getUserDefinedRecordId()
      Get 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1
      String getUserDefinedStreamId()
      Get 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main
      Long getVideoBitrate()
      Get 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。
      Long getVideoFPS()
      Get 白板推流视频帧率，取值范围[0, 30]，默认20fps
      Whiteboard getWhiteboard()
      Get 白板参数，例如白板宽高、背景颜色等
      void setAutoManageBackup​(Boolean AutoManageBackup)
      Set 对主白板推流任务进行操作时，是否同时同步操作备份任务
      void setAutoPublish​(Boolean AutoPublish)
      Set 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。
      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 setIMAuthParam​(AuthParam IMAuthParam)
      Set IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。
      void setPrivateMapKey​(String PrivateMapKey)
      Set TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。
      void setPushUserId​(String PushUserId)
      Set 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。
      void setPushUserSig​(String PushUserSig)
      Set 与PushUserId对应的IM签名(usersig)。
      void setRoomId​(Long RoomId)
      Set 需要推流的白板房间号，取值范围: (1, 4294967295)。 1.
      void setSdkAppId​(Long SdkAppId)
      Set 客户的SdkAppId
      void setTRTCAuthParam​(AuthParam TRTCAuthParam)
      Set TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
      void setTRTCEnterRoomMode​(String TRTCEnterRoomMode)
      Set 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。
      void setTRTCRoomId​(Long TRTCRoomId)
      Set TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。
      void setTRTCRoomIdStr​(String TRTCRoomIdStr)
      Set TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
      void setUserDefinedRecordId​(String UserDefinedRecordId)
      Set 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1
      void setUserDefinedStreamId​(String UserDefinedStreamId)
      Set 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main
      void setVideoBitrate​(Long VideoBitrate)
      Set 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。
      void setVideoFPS​(Long VideoFPS)
      Set 白板推流视频帧率，取值范围[0, 30]，默认20fps
      void setWhiteboard​(Whiteboard Whiteboard)
      Set 白板参数，例如白板宽高、背景颜色等
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • StartWhiteboardPushRequest

        public StartWhiteboardPushRequest()

      • StartWhiteboardPushRequest

        public StartWhiteboardPushRequest​(StartWhiteboardPushRequest 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 客户的SdkAppId
        Returns:
        SdkAppId 客户的SdkAppId

      • setSdkAppId

        public void setSdkAppId​(Long SdkAppId)
        Set 客户的SdkAppId
        Parameters:
        SdkAppId - 客户的SdkAppId

      • getRoomId

        public Long getRoomId()
        Get 需要推流的白板房间号，取值范围: (1, 4294967295)。 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID（比如RoomId为1234，则IM群组的GroupID为"1234"）加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下，默认会以RoomId作为白板流进行推流的TRTC房间号。
        Returns:
        RoomId 需要推流的白板房间号，取值范围: (1, 4294967295)。 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID（比如RoomId为1234，则IM群组的GroupID为"1234"）加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下，默认会以RoomId作为白板流进行推流的TRTC房间号。

      • setRoomId

        public void setRoomId​(Long RoomId)
        Set 需要推流的白板房间号，取值范围: (1, 4294967295)。 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID（比如RoomId为1234，则IM群组的GroupID为"1234"）加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下，默认会以RoomId作为白板流进行推流的TRTC房间号。
        Parameters:
        RoomId - 需要推流的白板房间号，取值范围: (1, 4294967295)。 1. 白板推流默认以RoomId的字符串表达形式作为IM群组的GroupID（比如RoomId为1234，则IM群组的GroupID为"1234"）加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。 2. 在没有指定TRTCRoomId和TRTCRoomIdStr的情况下，默认会以RoomId作为白板流进行推流的TRTC房间号。

      • getPushUserId

        public String getPushUserId()
        Get 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。
        Returns:
        PushUserId 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。

      • setPushUserId

        public void setPushUserId​(String PushUserId)
        Set 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。
        Parameters:
        PushUserId - 用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务与其他使用场景帐号互踢，影响正常推流。

      • getPushUserSig

        public String getPushUserSig()
        Get 与PushUserId对应的IM签名(usersig)。
        Returns:
        PushUserSig 与PushUserId对应的IM签名(usersig)。

      • setPushUserSig

        public void setPushUserSig​(String PushUserSig)
        Set 与PushUserId对应的IM签名(usersig)。
        Parameters:
        PushUserSig - 与PushUserId对应的IM签名(usersig)。

      • 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 - 备份白板推流相关参数。 指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。

      • getPrivateMapKey

        public String getPrivateMapKey()
        Get TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。
        Returns:
        PrivateMapKey TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。

      • setPrivateMapKey

        public void setPrivateMapKey​(String PrivateMapKey)
        Set TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。
        Parameters:
        PrivateMapKey - TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。

      • getVideoFPS

        public Long getVideoFPS()
        Get 白板推流视频帧率，取值范围[0, 30]，默认20fps
        Returns:
        VideoFPS 白板推流视频帧率，取值范围[0, 30]，默认20fps

      • setVideoFPS

        public void setVideoFPS​(Long VideoFPS)
        Set 白板推流视频帧率，取值范围[0, 30]，默认20fps
        Parameters:
        VideoFPS - 白板推流视频帧率，取值范围[0, 30]，默认20fps

      • getVideoBitrate

        public Long getVideoBitrate()
        Get 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。
        Returns:
        VideoBitrate 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。

      • setVideoBitrate

        public void setVideoBitrate​(Long VideoBitrate)
        Set 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。
        Parameters:
        VideoBitrate - 白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。

      • getAutoRecord

        public Boolean getAutoRecord()
        Get 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
        Returns:
        AutoRecord 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。

      • setAutoRecord

        public void setAutoRecord​(Boolean AutoRecord)
        Set 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。
        Parameters:
        AutoRecord - 在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。

      • getUserDefinedRecordId

        public String getUserDefinedRecordId()
        Get 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1
        Returns:
        UserDefinedRecordId 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1

      • setUserDefinedRecordId

        public void setUserDefinedRecordId​(String UserDefinedRecordId)
        Set 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1
        Parameters:
        UserDefinedRecordId - 指定白板推流录制的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自动进行白板推流录制。 默认RecordId生成规则如下： urlencode(SdkAppID_RoomID_PushUserID) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：RecordId = 12345678_12345_push_user_1

      • getAutoPublish

        public Boolean getAutoPublish()
        Get 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。
        Returns:
        AutoPublish 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。

      • setAutoPublish

        public void setAutoPublish​(Boolean AutoPublish)
        Set 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。
        Parameters:
        AutoPublish - 在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。

      • getUserDefinedStreamId

        public String getUserDefinedStreamId()
        Get 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main
        Returns:
        UserDefinedStreamId 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main

      • setUserDefinedStreamId

        public void setUserDefinedStreamId​(String UserDefinedStreamId)
        Set 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main
        Parameters:
        UserDefinedStreamId - 指定实时音视频在旁路白板推流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 那么：StreamID = 12345678_12345_push_user_1_main

      • getExtraData

        public String getExtraData()
        Get 内部参数，不需要关注此参数
        Returns:
        ExtraData 内部参数，不需要关注此参数

      • setExtraData

        public void setExtraData​(String ExtraData)
        Set 内部参数，不需要关注此参数
        Parameters:
        ExtraData - 内部参数，不需要关注此参数

      • getTRTCRoomId

        public Long getTRTCRoomId()
        Get TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。
        Returns:
        TRTCRoomId TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。

      • setTRTCRoomId

        public void setTRTCRoomId​(Long TRTCRoomId)
        Set TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。
        Parameters:
        TRTCRoomId - TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了RoomId与TRTCRoomId的情况下，优先使用TRTCRoomId作为白板流进行推流的TRTC房间号。 当指定了TRTCRoomIdStr的情况下，此字段将被忽略。

      • getTRTCRoomIdStr

        public String getTRTCRoomIdStr()
        Get TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
        Returns:
        TRTCRoomIdStr TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。

      • setTRTCRoomIdStr

        public void setTRTCRoomIdStr​(String TRTCRoomIdStr)
        Set TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。
        Parameters:
        TRTCRoomIdStr - TRTC字符串类型房间号。 在指定了TRTCRoomIdStr的情况下，会优先使用TRTCRoomIdStr作为白板流进行推流的TRTC房间号。

      • getIMAuthParam

        public AuthParam getIMAuthParam()
        Get IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。
        Returns:
        IMAuthParam IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。

      • setIMAuthParam

        public void setIMAuthParam​(AuthParam IMAuthParam)
        Set IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。
        Parameters:
        IMAuthParam - IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。

      • getTRTCAuthParam

        public AuthParam getTRTCAuthParam()
        Get TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
        Returns:
        TRTCAuthParam TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。

      • setTRTCAuthParam

        public void setTRTCAuthParam​(AuthParam TRTCAuthParam)
        Set TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。
        Parameters:
        TRTCAuthParam - TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。

      • getTRTCEnterRoomMode

        public String getTRTCEnterRoomMode()
        Get 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。
        Returns:
        TRTCEnterRoomMode 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。

      • setTRTCEnterRoomMode

        public void setTRTCEnterRoomMode​(String TRTCEnterRoomMode)
        Set 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。
        Parameters:
        TRTCEnterRoomMode - 指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表现更佳。