Package com.tencentcloudapi.live.v20180801.models

Class ModifyLivePullStreamTaskRequest

  • public class ModifyLivePullStreamTaskRequest
extends AbstractModel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getBackupSourceType()
      Get 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1.
      String getBackupSourceUrl()
      Get 备源 URL。 只允许填一个备源 URL
      String[] getCallbackEvents()
      Get 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
      String getCallbackUrl()
      Get 自定义回调地址。 相关事件会回调到该地址。
      String getComment()
      Get 任务备注。
      String getEndTime()
      Get 结束时间，注意： 1.
      Long getFileIndex()
      Get 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。
      Long getOffsetTime()
      Get 指定播放文件偏移。 注意： 1.
      String getOperator()
      Get 操作人姓名。
      String[] getSourceUrls()
      Get 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。
      String getStartTime()
      Get 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
      String getStatus()
      Get 任务状态： enable - 启用， pause - 暂停。
      String getTaskId()
      Get 任务Id。
      Long getVodLocalMode()
      Get 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。
      Long getVodLoopTimes()
      Get 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。
      String getVodRefreshType()
      Get 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。
      PullPushWatermarkInfo[] getWatermarkList()
      Get 水印信息列表。 注意： 1.
      void setBackupSourceType​(String BackupSourceType)
      Set 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1.
      void setBackupSourceUrl​(String BackupSourceUrl)
      Set 备源 URL。 只允许填一个备源 URL
      void setCallbackEvents​(String[] CallbackEvents)
      Set 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
      void setCallbackUrl​(String CallbackUrl)
      Set 自定义回调地址。 相关事件会回调到该地址。
      void setComment​(String Comment)
      Set 任务备注。
      void setEndTime​(String EndTime)
      Set 结束时间，注意： 1.
      void setFileIndex​(Long FileIndex)
      Set 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。
      void setOffsetTime​(Long OffsetTime)
      Set 指定播放文件偏移。 注意： 1.
      void setOperator​(String Operator)
      Set 操作人姓名。
      void setSourceUrls​(String[] SourceUrls)
      Set 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。
      void setStartTime​(String StartTime)
      Set 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
      void setStatus​(String Status)
      Set 任务状态： enable - 启用， pause - 暂停。
      void setTaskId​(String TaskId)
      Set 任务Id。
      void setVodLocalMode​(Long VodLocalMode)
      Set 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。
      void setVodLoopTimes​(Long VodLoopTimes)
      Set 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。
      void setVodRefreshType​(String VodRefreshType)
      Set 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。
      void setWatermarkList​(PullPushWatermarkInfo[] WatermarkList)
      Set 水印信息列表。 注意： 1.
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • ModifyLivePullStreamTaskRequest

        public ModifyLivePullStreamTaskRequest()

      • ModifyLivePullStreamTaskRequest

        public ModifyLivePullStreamTaskRequest​(ModifyLivePullStreamTaskRequest 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

      • getTaskId

        public String getTaskId()
        Get 任务Id。
        Returns:
        TaskId 任务Id。

      • setTaskId

        public void setTaskId​(String TaskId)
        Set 任务Id。
        Parameters:
        TaskId - 任务Id。

      • getOperator

        public String getOperator()
        Get 操作人姓名。
        Returns:
        Operator 操作人姓名。

      • setOperator

        public void setOperator​(String Operator)
        Set 操作人姓名。
        Parameters:
        Operator - 操作人姓名。

      • getSourceUrls

        public String[] getSourceUrls()
        Get 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。
        Returns:
        SourceUrls 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。

      • setSourceUrls

        public void setSourceUrls​(String[] SourceUrls)
        Set 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。
        Parameters:
        SourceUrls - 拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。

      • getStartTime

        public String getStartTime()
        Get 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
        Returns:
        StartTime 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。

      • setStartTime

        public void setStartTime​(String StartTime)
        Set 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
        Parameters:
        StartTime - 开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。

      • getEndTime

        public String getEndTime()
        Get 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于七天。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
        Returns:
        EndTime 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于七天。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。

      • setEndTime

        public void setEndTime​(String EndTime)
        Set 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于七天。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。
        Parameters:
        EndTime - 结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于七天。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。

      • getVodLoopTimes

        public Long getVodLoopTimes()
        Get 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。
        Returns:
        VodLoopTimes 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。

      • setVodLoopTimes

        public void setVodLoopTimes​(Long VodLoopTimes)
        Set 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。
        Parameters:
        VodLoopTimes - 点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。

      • getVodRefreshType

        public String getVodRefreshType()
        Get 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。
        Returns:
        VodRefreshType 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。

      • setVodRefreshType

        public void setVodRefreshType​(String VodRefreshType)
        Set 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。
        Parameters:
        VodRefreshType - 点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。

      • getStatus

        public String getStatus()
        Get 任务状态： enable - 启用， pause - 暂停。
        Returns:
        Status 任务状态： enable - 启用， pause - 暂停。

      • setStatus

        public void setStatus​(String Status)
        Set 任务状态： enable - 启用， pause - 暂停。
        Parameters:
        Status - 任务状态： enable - 启用， pause - 暂停。

      • getCallbackEvents

        public String[] getCallbackEvents()
        Get 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
        Returns:
        CallbackEvents 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。

      • setCallbackEvents

        public void setCallbackEvents​(String[] CallbackEvents)
        Set 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。
        Parameters:
        CallbackEvents - 选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。

      • getCallbackUrl

        public String getCallbackUrl()
        Get 自定义回调地址。 相关事件会回调到该地址。
        Returns:
        CallbackUrl 自定义回调地址。 相关事件会回调到该地址。

      • setCallbackUrl

        public void setCallbackUrl​(String CallbackUrl)
        Set 自定义回调地址。 相关事件会回调到该地址。
        Parameters:
        CallbackUrl - 自定义回调地址。 相关事件会回调到该地址。

      • getFileIndex

        public Long getFileIndex()
        Get 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。
        Returns:
        FileIndex 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。

      • setFileIndex

        public void setFileIndex​(Long FileIndex)
        Set 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。
        Parameters:
        FileIndex - 指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。

      • getOffsetTime

        public Long getOffsetTime()
        Get 指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。
        Returns:
        OffsetTime 指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。

      • setOffsetTime

        public void setOffsetTime​(Long OffsetTime)
        Set 指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。
        Parameters:
        OffsetTime - 指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。

      • getComment

        public String getComment()
        Get 任务备注。
        Returns:
        Comment 任务备注。

      • setComment

        public void setComment​(String Comment)
        Set 任务备注。
        Parameters:
        Comment - 任务备注。

      • getBackupSourceType

        public String getBackupSourceType()
        Get 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 将该参数置为空，则可将任务去除备源信息。 3. 主直播源拉流中断时，自动使用备源进行拉流。 4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。
        Returns:
        BackupSourceType 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 将该参数置为空，则可将任务去除备源信息。 3. 主直播源拉流中断时，自动使用备源进行拉流。 4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。

      • setBackupSourceType

        public void setBackupSourceType​(String BackupSourceType)
        Set 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 将该参数置为空，则可将任务去除备源信息。 3. 主直播源拉流中断时，自动使用备源进行拉流。 4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。
        Parameters:
        BackupSourceType - 备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 将该参数置为空，则可将任务去除备源信息。 3. 主直播源拉流中断时，自动使用备源进行拉流。 4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。

      • getBackupSourceUrl

        public String getBackupSourceUrl()
        Get 备源 URL。 只允许填一个备源 URL
        Returns:
        BackupSourceUrl 备源 URL。 只允许填一个备源 URL

      • setBackupSourceUrl

        public void setBackupSourceUrl​(String BackupSourceUrl)
        Set 备源 URL。 只允许填一个备源 URL
        Parameters:
        BackupSourceUrl - 备源 URL。 只允许填一个备源 URL

      • getWatermarkList

        public PullPushWatermarkInfo[] getWatermarkList()
        Get 水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg等。 4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。 5. 直播源任务修改水印后，水印立即生效。 6. 清除水印时，需携带该水印列表参数，内容为空数组。 7. 暂不支持动图水印。
        Returns:
        WatermarkList 水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg等。 4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。 5. 直播源任务修改水印后，水印立即生效。 6. 清除水印时，需携带该水印列表参数，内容为空数组。 7. 暂不支持动图水印。

      • setWatermarkList

        public void setWatermarkList​(PullPushWatermarkInfo[] WatermarkList)
        Set 水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg等。 4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。 5. 直播源任务修改水印后，水印立即生效。 6. 清除水印时，需携带该水印列表参数，内容为空数组。 7. 暂不支持动图水印。
        Parameters:
        WatermarkList - 水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg等。 4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。 5. 直播源任务修改水印后，水印立即生效。 6. 清除水印时，需携带该水印列表参数，内容为空数组。 7. 暂不支持动图水印。

      • getVodLocalMode

        public Long getVodLocalMode()
        Get 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。
        Returns:
        VodLocalMode 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。

      • setVodLocalMode

        public void setVodLocalMode​(Long VodLocalMode)
        Set 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。
        Parameters:
        VodLocalMode - 点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。