Documentation
¶
Index ¶
- Constants
- Variables
- type BindCert
- type BindCertBody
- type BindCertQuery
- type BindCertReq
- type BindCertRes
- type BindCertResResponseMetadata
- type BindCertResResponseMetadataError
- type BindEncryptDRM
- type BindEncryptDRMBody
- type BindEncryptDRMQuery
- type BindEncryptDRMReq
- type BindEncryptDRMRes
- type BindEncryptDRMResResponseMetadata
- type Components1404CjzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesTosparam
- type Components1523StvSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguage
- type Components17Ohct5SchemasDescribeliveasrdurationdataresPropertiesResultPropertiesAsrdurationdetaildataItemsPropertiesAsrdurationdataItems
- type Components1C398ShSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesTargetlanguageItems
- type Components1Hkcrc4SchemasListvhostsnapshotpresetresPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetPropertiesCallbackdetail
- type Components1Nf1A8CSchemasListpulltopushtaskv2ResPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems
- type Components1O8E0AlSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguagePropertiesBorder
- type Components1Via6UrSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesTosparam
- type Components1Wv3ClqSchemasUpdatetranscodepresetbodyPropertiesTranscodestructPropertiesAbtestAdditionalproperties
- type Components44Na0KSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparam
- type ComponentsAoysk3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparam
- type ComponentsBbqv7RSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesTosparam
- type ComponentsFuamuzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfig
- type ComponentsGg7M1TSchemasListpulltopushtaskresPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems
- type ComponentsJ1MbxoSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesPosition
- type ComponentsKovkk9SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesVodparam
- type ComponentsKqy98ZSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4Param
- type ComponentsQms0JiSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesVodparam
- type ComponentsS0Ofr3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesVodparam
- type CreateCert
- type CreateCertBody
- type CreateCertBodyRsa
- type CreateCertQuery
- type CreateCertReq
- type CreateCertRes
- type CreateCertResResponseMetadata
- type CreateCertResResponseMetadataError
- type CreateCertResResult
- type CreateCloudMixTask
- type CreateCloudMixTaskBody
- type CreateCloudMixTaskBodyMixedRules
- type CreateCloudMixTaskBodyMixedRulesInputLayout
- type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItem
- type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout
- type CreateCloudMixTaskBodyMixedRulesInputLayoutScene
- type CreateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem
- type CreateCloudMixTaskBodyMixedRulesInputSourceItem
- type CreateCloudMixTaskBodyMixedRulesOutput
- type CreateCloudMixTaskBodyMixedRulesOutputAudio
- type CreateCloudMixTaskBodyMixedRulesOutputCallback
- type CreateCloudMixTaskBodyMixedRulesOutputVideo
- type CreateCloudMixTaskQuery
- type CreateCloudMixTaskReq
- type CreateCloudMixTaskRes
- type CreateCloudMixTaskResResponseMetadata
- type CreateCloudMixTaskResResult
- type CreateCloudMixTaskResResultData
- type CreateDomainV2
- type CreateDomainV2Body
- type CreateDomainV2BodyDomainsItem
- type CreateDomainV2BodyTagsItem
- type CreateDomainV2Query
- type CreateDomainV2Req
- type CreateDomainV2Res
- type CreateDomainV2ResResponseMetadata
- type CreateDomainV2ResResponseMetadataError
- type CreateLiveVideoQualityAnalysisTask
- type CreateLiveVideoQualityAnalysisTaskBody
- type CreateLiveVideoQualityAnalysisTaskQuery
- type CreateLiveVideoQualityAnalysisTaskReq
- type CreateLiveVideoQualityAnalysisTaskRes
- type CreateLiveVideoQualityAnalysisTaskResResponseMetadata
- type CreateLiveVideoQualityAnalysisTaskResResult
- type CreatePullToPushGroup
- type CreatePullToPushGroupBody
- type CreatePullToPushGroupBodyTagsItem
- type CreatePullToPushGroupQuery
- type CreatePullToPushGroupReq
- type CreatePullToPushGroupRes
- type CreatePullToPushGroupResResponseMetadata
- type CreatePullToPushTask
- type CreatePullToPushTaskBody
- type CreatePullToPushTaskBodyVodSrcAddrsItem
- type CreatePullToPushTaskBodyWatermark
- type CreatePullToPushTaskQuery
- type CreatePullToPushTaskReq
- type CreatePullToPushTaskRes
- type CreatePullToPushTaskResResponseMetadata
- type CreatePullToPushTaskResResponseMetadataError
- type CreatePullToPushTaskResResult
- type CreateRecordPresetV2
- type CreateRecordPresetV2Body
- type CreateRecordPresetV2BodyRecordPresetConfig
- type CreateRecordPresetV2BodyRecordPresetConfigFlvParam
- type CreateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam
- type CreateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam
- type CreateRecordPresetV2BodyRecordPresetConfigHlsParam
- type CreateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam
- type CreateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam
- type CreateRecordPresetV2BodyRecordPresetConfigMp4Param
- type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam
- type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam
- type CreateRecordPresetV2Query
- type CreateRecordPresetV2Req
- type CreateRecordPresetV2Res
- type CreateRecordPresetV2ResResponseMetadata
- type CreateRecordPresetV2ResResponseMetadataError
- type CreateSnapshotPreset
- type CreateSnapshotPresetBody
- type CreateSnapshotPresetBodyCallbackDetailListItem
- type CreateSnapshotPresetQuery
- type CreateSnapshotPresetReq
- type CreateSnapshotPresetRes
- type CreateSnapshotPresetResResponseMetadata
- type CreateSnapshotPresetResResponseMetadataError
- type CreateSubtitleTranscodePreset
- type CreateSubtitleTranscodePresetBody
- type CreateSubtitleTranscodePresetBodyPosition
- type CreateSubtitleTranscodePresetBodyPositionRelative
- type CreateSubtitleTranscodePresetBodySourceLanguage
- type CreateSubtitleTranscodePresetBodySourceLanguageBorder
- type CreateSubtitleTranscodePresetBodyTargetLanguageItem
- type CreateSubtitleTranscodePresetBodyTargetLanguageItemBorder
- type CreateSubtitleTranscodePresetQuery
- type CreateSubtitleTranscodePresetReq
- type CreateSubtitleTranscodePresetRes
- type CreateSubtitleTranscodePresetResResponseMetadata
- type CreateTimeShiftPresetV2
- type CreateTimeShiftPresetV2Body
- type CreateTimeShiftPresetV2Query
- type CreateTimeShiftPresetV2Req
- type CreateTimeShiftPresetV2Res
- type CreateTimeShiftPresetV2ResResponseMetadata
- type CreateTimeShiftPresetV2ResResponseMetadataError
- type CreateTranscodePreset
- type CreateTranscodePresetBody
- type CreateTranscodePresetQuery
- type CreateTranscodePresetReq
- type CreateTranscodePresetRes
- type CreateTranscodePresetResResponseMetadata
- type CreateTranscodePresetResResponseMetadataError
- type CreateWatermarkPreset
- type CreateWatermarkPresetBody
- type CreateWatermarkPresetQuery
- type CreateWatermarkPresetReq
- type CreateWatermarkPresetRes
- type CreateWatermarkPresetResResponseMetadata
- type CreateWatermarkPresetResResponseMetadataError
- type DeleteCMAFConfig
- type DeleteCMAFConfigBody
- type DeleteCMAFConfigQuery
- type DeleteCMAFConfigReq
- type DeleteCMAFConfigRes
- type DeleteCMAFConfigResResponseMetadata
- type DeleteCallback
- type DeleteCallbackBody
- type DeleteCallbackQuery
- type DeleteCallbackReq
- type DeleteCallbackRes
- type DeleteCallbackResResponseMetadata
- type DeleteCallbackResResponseMetadataError
- type DeleteCert
- type DeleteCertBody
- type DeleteCertQuery
- type DeleteCertReq
- type DeleteCertRes
- type DeleteCertResResponseMetadata
- type DeleteCertResResponseMetadataError
- type DeleteCloudMixTask
- type DeleteCloudMixTaskBody
- type DeleteCloudMixTaskQuery
- type DeleteCloudMixTaskReq
- type DeleteCloudMixTaskRes
- type DeleteCloudMixTaskResResponseMetadata
- type DeleteCloudMixTaskResResult
- type DeleteClusterRateLimit
- type DeleteClusterRateLimitBody
- type DeleteClusterRateLimitQuery
- type DeleteClusterRateLimitReq
- type DeleteClusterRateLimitRes
- type DeleteClusterRateLimitResResponseMetadata
- type DeleteDomain
- type DeleteDomainBody
- type DeleteDomainQuery
- type DeleteDomainReq
- type DeleteDomainRes
- type DeleteDomainResResponseMetadata
- type DeleteDomainResResponseMetadataError
- type DeleteFormatAccessRule
- type DeleteFormatAccessRuleBody
- type DeleteFormatAccessRuleQuery
- type DeleteFormatAccessRuleReq
- type DeleteFormatAccessRuleRes
- type DeleteFormatAccessRuleResResponseMetadata
- type DeleteHLSConfig
- type DeleteHLSConfigBody
- type DeleteHLSConfigQuery
- type DeleteHLSConfigReq
- type DeleteHLSConfigRes
- type DeleteHLSConfigResResponseMetadata
- type DeleteHTTPHeaderConfig
- type DeleteHTTPHeaderConfigBody
- type DeleteHTTPHeaderConfigQuery
- type DeleteHTTPHeaderConfigReq
- type DeleteHTTPHeaderConfigRes
- type DeleteHTTPHeaderConfigResResponseMetadata
- type DeleteIPAccessRule
- type DeleteIPAccessRuleBody
- type DeleteIPAccessRuleQuery
- type DeleteIPAccessRuleReq
- type DeleteIPAccessRuleRes
- type DeleteIPAccessRuleResResponseMetadata
- type DeleteLatencyConfig
- type DeleteLatencyConfigBody
- type DeleteLatencyConfigQuery
- type DeleteLatencyConfigReq
- type DeleteLatencyConfigRes
- type DeleteLatencyConfigResResponseMetadata
- type DeleteLiveVideoQualityAnalysisTask
- type DeleteLiveVideoQualityAnalysisTaskBody
- type DeleteLiveVideoQualityAnalysisTaskQuery
- type DeleteLiveVideoQualityAnalysisTaskReq
- type DeleteLiveVideoQualityAnalysisTaskRes
- type DeleteLiveVideoQualityAnalysisTaskResResponseMetadata
- type DeletePullToPushGroup
- type DeletePullToPushGroupBody
- type DeletePullToPushGroupQuery
- type DeletePullToPushGroupReq
- type DeletePullToPushGroupRes
- type DeletePullToPushGroupResResponseMetadata
- type DeletePullToPushTask
- type DeletePullToPushTaskBody
- type DeletePullToPushTaskQuery
- type DeletePullToPushTaskReq
- type DeletePullToPushTaskRes
- type DeletePullToPushTaskResResponseMetadata
- type DeletePullToPushTaskResResponseMetadataError
- type DeleteRecordPreset
- type DeleteRecordPresetBody
- type DeleteRecordPresetQuery
- type DeleteRecordPresetReq
- type DeleteRecordPresetRes
- type DeleteRecordPresetResResponseMetadata
- type DeleteRecordPresetResResponseMetadataError
- type DeleteReferer
- type DeleteRefererBody
- type DeleteRefererQuery
- type DeleteRefererReq
- type DeleteRefererRes
- type DeleteRefererResResponseMetadata
- type DeleteRefererResResponseMetadataError
- type DeleteRegionAccessRule
- type DeleteRegionAccessRuleBody
- type DeleteRegionAccessRuleQuery
- type DeleteRegionAccessRuleReq
- type DeleteRegionAccessRuleRes
- type DeleteRegionAccessRuleResResponseMetadata
- type DeleteRelaySourceRewrite
- type DeleteRelaySourceRewriteBody
- type DeleteRelaySourceRewriteQuery
- type DeleteRelaySourceRewriteReq
- type DeleteRelaySourceRewriteRes
- type DeleteRelaySourceRewriteResResponseMetadata
- type DeleteRelaySourceRewriteResResult
- type DeleteRelaySourceV3
- type DeleteRelaySourceV3Body
- type DeleteRelaySourceV3Query
- type DeleteRelaySourceV3Req
- type DeleteRelaySourceV3Res
- type DeleteRelaySourceV3ResResponseMetadata
- type DeleteRelaySourceV3ResResponseMetadataError
- type DeleteSnapshotPreset
- type DeleteSnapshotPresetBody
- type DeleteSnapshotPresetQuery
- type DeleteSnapshotPresetReq
- type DeleteSnapshotPresetRes
- type DeleteSnapshotPresetResResponseMetadata
- type DeleteSnapshotPresetResResponseMetadataError
- type DeleteSubtitleTranscodePreset
- type DeleteSubtitleTranscodePresetBody
- type DeleteSubtitleTranscodePresetQuery
- type DeleteSubtitleTranscodePresetReq
- type DeleteSubtitleTranscodePresetRes
- type DeleteSubtitleTranscodePresetResResponseMetadata
- type DeleteTimeShiftPresetV2
- type DeleteTimeShiftPresetV2Body
- type DeleteTimeShiftPresetV2Query
- type DeleteTimeShiftPresetV2Req
- type DeleteTimeShiftPresetV2Res
- type DeleteTimeShiftPresetV2ResResponseMetadata
- type DeleteTimeShiftPresetV2ResResponseMetadataError
- type DeleteTranscodePreset
- type DeleteTranscodePresetBody
- type DeleteTranscodePresetQuery
- type DeleteTranscodePresetReq
- type DeleteTranscodePresetRes
- type DeleteTranscodePresetResResponseMetadata
- type DeleteTranscodePresetResResponseMetadataError
- type DeleteUserAgentAccessRule
- type DeleteUserAgentAccessRuleBody
- type DeleteUserAgentAccessRuleQuery
- type DeleteUserAgentAccessRuleReq
- type DeleteUserAgentAccessRuleRes
- type DeleteUserAgentAccessRuleResResponseMetadata
- type DeleteWatermarkPreset
- type DeleteWatermarkPresetBody
- type DeleteWatermarkPresetQuery
- type DeleteWatermarkPresetReq
- type DeleteWatermarkPresetRes
- type DeleteWatermarkPresetResResponseMetadata
- type DeleteWatermarkPresetResResponseMetadataError
- type DescribeAuth
- type DescribeAuthBody
- type DescribeAuthQuery
- type DescribeAuthReq
- type DescribeAuthRes
- type DescribeAuthResResponseMetadata
- type DescribeAuthResResponseMetadataError
- type DescribeAuthResResult
- type DescribeAuthResResultAuthListItem
- type DescribeAuthResResultAuthListPropertiesItemsItem
- type DescribeCDNSnapshotHistory
- type DescribeCDNSnapshotHistoryBody
- type DescribeCDNSnapshotHistoryQuery
- type DescribeCDNSnapshotHistoryReq
- type DescribeCDNSnapshotHistoryRes
- type DescribeCDNSnapshotHistoryResResponseMetadata
- type DescribeCDNSnapshotHistoryResResponseMetadataError
- type DescribeCDNSnapshotHistoryResResult
- type DescribeCDNSnapshotHistoryResResultDataItem
- type DescribeCDNSnapshotHistoryResResultPagination
- type DescribeCMAFConfig
- type DescribeCMAFConfigBody
- type DescribeCMAFConfigQuery
- type DescribeCMAFConfigReq
- type DescribeCMAFConfigRes
- type DescribeCMAFConfigResResponseMetadata
- type DescribeCMAFConfigResResult
- type DescribeCMAFConfigResResultCMAFConfigListItem
- type DescribeCallback
- type DescribeCallbackBody
- type DescribeCallbackQuery
- type DescribeCallbackReq
- type DescribeCallbackRes
- type DescribeCallbackResResponseMetadata
- type DescribeCallbackResResponseMetadataError
- type DescribeCallbackResResult
- type DescribeCallbackResResultCallbackListItem
- type DescribeCallbackResResultCallbackListItemAuthField
- type DescribeCallbackResResultCallbackListPropertiesItemsItem
- type DescribeCertDRM
- type DescribeCertDRMBody
- type DescribeCertDRMQuery
- type DescribeCertDRMReq
- type DescribeCertDRMRes
- type DescribeCertDRMResResponseMetadata
- type DescribeCertDetailSecretV2
- type DescribeCertDetailSecretV2Body
- type DescribeCertDetailSecretV2Query
- type DescribeCertDetailSecretV2Req
- type DescribeCertDetailSecretV2Res
- type DescribeCertDetailSecretV2ResResponseMetadata
- type DescribeCertDetailSecretV2ResResponseMetadataError
- type DescribeCertDetailSecretV2ResResult
- type DescribeCertDetailSecretV2ResResultSSL
- type DescribeCertDetailSecretV2ResResultSSLChainBriefInfoItem
- type DescribeClosedStreamInfoByPage
- type DescribeClosedStreamInfoByPageBody
- type DescribeClosedStreamInfoByPageQuery
- type DescribeClosedStreamInfoByPageReq
- type DescribeClosedStreamInfoByPageRes
- type DescribeClosedStreamInfoByPageResResponseMetadata
- type DescribeClosedStreamInfoByPageResResponseMetadataError
- type DescribeClosedStreamInfoByPageResResult
- type DescribeClosedStreamInfoByPageResResultStreamInfoListItem
- type DescribeClusterRateLimit
- type DescribeClusterRateLimitBody
- type DescribeClusterRateLimitQuery
- type DescribeClusterRateLimitReq
- type DescribeClusterRateLimitRes
- type DescribeClusterRateLimitResResponseMetadata
- type DescribeClusterRateLimitResResult
- type DescribeClusterRateLimitResResultClusterRateLimitItemListItem
- type DescribeDomain
- type DescribeDomainBody
- type DescribeDomainQuery
- type DescribeDomainReq
- type DescribeDomainRes
- type DescribeDomainResResponseMetadata
- type DescribeDomainResResponseMetadataError
- type DescribeDomainResResult
- type DescribeDomainResResultDomainListItem
- type DescribeEncryptDRM
- type DescribeEncryptDRMBody
- type DescribeEncryptDRMQuery
- type DescribeEncryptDRMReq
- type DescribeEncryptDRMRes
- type DescribeEncryptDRMResResponseMetadata
- type DescribeEncryptDRMResResult
- type DescribeEncryptDRMResResultDRMItem
- type DescribeEncryptHLS
- type DescribeEncryptHLSBody
- type DescribeEncryptHLSQuery
- type DescribeEncryptHLSReq
- type DescribeEncryptHLSRes
- type DescribeEncryptHLSResResponseMetadata
- type DescribeEncryptHLSResResult
- type DescribeForbiddenStreamInfoByPage
- type DescribeForbiddenStreamInfoByPageBody
- type DescribeForbiddenStreamInfoByPageQuery
- type DescribeForbiddenStreamInfoByPageReq
- type DescribeForbiddenStreamInfoByPageRes
- type DescribeForbiddenStreamInfoByPageResResponseMetadata
- type DescribeForbiddenStreamInfoByPageResResponseMetadataError
- type DescribeForbiddenStreamInfoByPageResResult
- type DescribeForbiddenStreamInfoByPageResResultStreamInfoListItem
- type DescribeFormatAccessRule
- type DescribeFormatAccessRuleBody
- type DescribeFormatAccessRuleQuery
- type DescribeFormatAccessRuleReq
- type DescribeFormatAccessRuleRes
- type DescribeFormatAccessRuleResResponseMetadata
- type DescribeFormatAccessRuleResResult
- type DescribeFormatAccessRuleResResultAccessRuleListsItem
- type DescribeFormatAccessRuleResResultAccessRuleListsItemFormatAccessRule
- type DescribeHLSConfig
- type DescribeHLSConfigBody
- type DescribeHLSConfigQuery
- type DescribeHLSConfigReq
- type DescribeHLSConfigRes
- type DescribeHLSConfigResResponseMetadata
- type DescribeHLSConfigResResult
- type DescribeHLSConfigResResultHLSConfigListItem
- type DescribeHTTPHeaderConfig
- type DescribeHTTPHeaderConfigBody
- type DescribeHTTPHeaderConfigQuery
- type DescribeHTTPHeaderConfigReq
- type DescribeHTTPHeaderConfigRes
- type DescribeHTTPHeaderConfigResResponseMetadata
- type DescribeHTTPHeaderConfigResResult
- type DescribeHTTPHeaderConfigResResultHeaderConfigListItem
- type DescribeHTTPHeaderConfigResResultHeaderConfigListPropertiesItemsItem
- type DescribeIPAccessRule
- type DescribeIPAccessRuleBody
- type DescribeIPAccessRuleQuery
- type DescribeIPAccessRuleReq
- type DescribeIPAccessRuleRes
- type DescribeIPAccessRuleResResponseMetadata
- type DescribeIPAccessRuleResResult
- type DescribeIPAccessRuleResResultAccessRuleListsItem
- type DescribeIPAccessRuleResResultAccessRuleListsItemIPAccessRule
- type DescribeLatencyConfig
- type DescribeLatencyConfigBody
- type DescribeLatencyConfigQuery
- type DescribeLatencyConfigReq
- type DescribeLatencyConfigRes
- type DescribeLatencyConfigResResponseMetadata
- type DescribeLatencyConfigResResult
- type DescribeLatencyConfigResResultLatencyConfigListItem
- type DescribeLicenseDRM
- type DescribeLicenseDRMBody
- type DescribeLicenseDRMQuery
- type DescribeLicenseDRMReq
- type DescribeLicenseDRMRes
- type DescribeLicenseDRMResResponseMetadata
- type DescribeLiveASRDurationData
- type DescribeLiveASRDurationDataBody
- type DescribeLiveASRDurationDataQuery
- type DescribeLiveASRDurationDataReq
- type DescribeLiveASRDurationDataRes
- type DescribeLiveASRDurationDataResResponseMetadata
- type DescribeLiveASRDurationDataResResult
- type DescribeLiveASRDurationDataResResultASRDurationDataItem
- type DescribeLiveASRDurationDataResResultASRDurationDetailDataItem
- type DescribeLiveBandwidthData
- type DescribeLiveBandwidthDataBody
- type DescribeLiveBandwidthDataBodyRegionListItem
- type DescribeLiveBandwidthDataBodyUserRegionListItem
- type DescribeLiveBandwidthDataQuery
- type DescribeLiveBandwidthDataReq
- type DescribeLiveBandwidthDataRes
- type DescribeLiveBandwidthDataResResponseMetadata
- type DescribeLiveBandwidthDataResResult
- type DescribeLiveBandwidthDataResResultBandwidthDataListItem
- type DescribeLiveBandwidthDataResResultBandwidthDetailDataListItem
- type DescribeLiveBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem
- type DescribeLiveBandwidthDataResResultRegionListItem
- type DescribeLiveBandwidthDataResResultUserRegionListItem
- type DescribeLiveBatchPushStreamMetrics
- type DescribeLiveBatchPushStreamMetricsBody
- type DescribeLiveBatchPushStreamMetricsQuery
- type DescribeLiveBatchPushStreamMetricsReq
- type DescribeLiveBatchPushStreamMetricsRes
- type DescribeLiveBatchPushStreamMetricsResResponseMetadata
- type DescribeLiveBatchPushStreamMetricsResResult
- type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListItem
- type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListPropertiesItemsItem
- type DescribeLiveISPData
- type DescribeLiveISPDataBody
- type DescribeLiveISPDataQuery
- type DescribeLiveISPDataReq
- type DescribeLiveISPDataRes
- type DescribeLiveISPDataResResponseMetadata
- type DescribeLiveISPDataResResult
- type DescribeLiveISPDataResResultISPListItem
- type DescribeLiveLogData
- type DescribeLiveLogDataBody
- type DescribeLiveLogDataQuery
- type DescribeLiveLogDataReq
- type DescribeLiveLogDataRes
- type DescribeLiveLogDataResResponseMetadata
- type DescribeLiveLogDataResResult
- type DescribeLiveLogDataResResultLogInfoListItem
- type DescribeLiveLogDataResResultPagination
- type DescribeLiveMetricBandwidthData
- type DescribeLiveMetricBandwidthDataBody
- type DescribeLiveMetricBandwidthDataBodyRegionListItem
- type DescribeLiveMetricBandwidthDataBodyUserRegionListItem
- type DescribeLiveMetricBandwidthDataQuery
- type DescribeLiveMetricBandwidthDataReq
- type DescribeLiveMetricBandwidthDataRes
- type DescribeLiveMetricBandwidthDataResResponseMetadata
- type DescribeLiveMetricBandwidthDataResResult
- type DescribeLiveMetricBandwidthDataResResultBandwidthDataListItem
- type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListItem
- type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem
- type DescribeLiveMetricBandwidthDataResResultRegionListItem
- type DescribeLiveMetricBandwidthDataResResultUserRegionListItem
- type DescribeLiveMetricTrafficData
- type DescribeLiveMetricTrafficDataBody
- type DescribeLiveMetricTrafficDataBodyRegionListItem
- type DescribeLiveMetricTrafficDataBodyUserRegionListItem
- type DescribeLiveMetricTrafficDataQuery
- type DescribeLiveMetricTrafficDataReq
- type DescribeLiveMetricTrafficDataRes
- type DescribeLiveMetricTrafficDataResResponseMetadata
- type DescribeLiveMetricTrafficDataResResult
- type DescribeLiveMetricTrafficDataResResultRegionListItem
- type DescribeLiveMetricTrafficDataResResultTrafficDataListItem
- type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListItem
- type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListPropertiesItemsItem
- type DescribeLiveMetricTrafficDataResResultUserRegionListItem
- type DescribeLiveP95PeakBandwidthData
- type DescribeLiveP95PeakBandwidthDataBody
- type DescribeLiveP95PeakBandwidthDataBodyRegionListItem
- type DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem
- type DescribeLiveP95PeakBandwidthDataQuery
- type DescribeLiveP95PeakBandwidthDataReq
- type DescribeLiveP95PeakBandwidthDataRes
- type DescribeLiveP95PeakBandwidthDataResResponseMetadata
- type DescribeLiveP95PeakBandwidthDataResResult
- type DescribeLiveP95PeakBandwidthDataResResultRegionListItem
- type DescribeLiveP95PeakBandwidthDataResResultUserRegionListItem
- type DescribeLivePlayStatusCodeData
- type DescribeLivePlayStatusCodeDataBody
- type DescribeLivePlayStatusCodeDataBodyRegionListItem
- type DescribeLivePlayStatusCodeDataBodyUserRegionListItem
- type DescribeLivePlayStatusCodeDataQuery
- type DescribeLivePlayStatusCodeDataReq
- type DescribeLivePlayStatusCodeDataRes
- type DescribeLivePlayStatusCodeDataResResponseMetadata
- type DescribeLivePlayStatusCodeDataResResult
- type DescribeLivePlayStatusCodeDataResResultRegionListItem
- type DescribeLivePlayStatusCodeDataResResultStatusDataListItem
- type DescribeLivePlayStatusCodeDataResResultStatusDataListPropertiesItemsItem
- type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListItem
- type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsItem
- type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsStatusSummaryDataListItem
- type DescribeLivePlayStatusCodeDataResResultStatusSummaryDataListItem
- type DescribeLivePlayStatusCodeDataResResultUserRegionListItem
- type DescribeLivePullToPushBandwidthData
- type DescribeLivePullToPushBandwidthDataBody
- type DescribeLivePullToPushBandwidthDataQuery
- type DescribeLivePullToPushBandwidthDataReq
- type DescribeLivePullToPushBandwidthDataRes
- type DescribeLivePullToPushBandwidthDataResResponseMetadata
- type DescribeLivePullToPushBandwidthDataResResponseMetadataError
- type DescribeLivePullToPushBandwidthDataResResult
- type DescribeLivePullToPushBandwidthDataResResultBandwidthDataListItem
- type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListItem
- type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem
- type DescribeLivePullToPushData
- type DescribeLivePullToPushDataBody
- type DescribeLivePullToPushDataQuery
- type DescribeLivePullToPushDataReq
- type DescribeLivePullToPushDataRes
- type DescribeLivePullToPushDataResResponseMetadata
- type DescribeLivePullToPushDataResResponseMetadataError
- type DescribeLivePullToPushDataResResult
- type DescribeLivePullToPushDataResResultPullToPushDataListItem
- type DescribeLivePullToPushDataResResultPullToPushDetailDataListItem
- type DescribeLivePullToPushDataResResultPullToPushDetailDataListPropertiesItemsItem
- type DescribeLivePushStreamInfoData
- type DescribeLivePushStreamInfoDataBody
- type DescribeLivePushStreamInfoDataQuery
- type DescribeLivePushStreamInfoDataReq
- type DescribeLivePushStreamInfoDataRes
- type DescribeLivePushStreamInfoDataResResponseMetadata
- type DescribeLivePushStreamInfoDataResResult
- type DescribeLivePushStreamInfoDataResResultPagination
- type DescribeLivePushStreamInfoDataResResultPushStreamInfoDataListItem
- type DescribeLivePushStreamMetrics
- type DescribeLivePushStreamMetricsBody
- type DescribeLivePushStreamMetricsQuery
- type DescribeLivePushStreamMetricsReq
- type DescribeLivePushStreamMetricsRes
- type DescribeLivePushStreamMetricsResResponseMetadata
- type DescribeLivePushStreamMetricsResResponseMetadataError
- type DescribeLivePushStreamMetricsResResult
- type DescribeLivePushStreamMetricsResResultMetricListItem
- type DescribeLiveRecordData
- type DescribeLiveRecordDataBody
- type DescribeLiveRecordDataQuery
- type DescribeLiveRecordDataReq
- type DescribeLiveRecordDataRes
- type DescribeLiveRecordDataResResponseMetadata
- type DescribeLiveRecordDataResResponseMetadataError
- type DescribeLiveRecordDataResResult
- type DescribeLiveRecordDataResResultRecordDataListItem
- type DescribeLiveRecordDataResResultRecordDetailDataListItem
- type DescribeLiveRecordDataResResultRecordDetailDataListPropertiesItemsItem
- type DescribeLiveRegionData
- type DescribeLiveRegionDataBody
- type DescribeLiveRegionDataQuery
- type DescribeLiveRegionDataReq
- type DescribeLiveRegionDataRes
- type DescribeLiveRegionDataResResponseMetadata
- type DescribeLiveRegionDataResResult
- type DescribeLiveRegionDataResResultAreasItem
- type DescribeLiveRegionDataResResultAreasPropertiesItemsItem
- type DescribeLiveRegionDataResResultAreasPropertiesItemsProvincesItem
- type DescribeLiveSnapshotData
- type DescribeLiveSnapshotDataBody
- type DescribeLiveSnapshotDataQuery
- type DescribeLiveSnapshotDataReq
- type DescribeLiveSnapshotDataRes
- type DescribeLiveSnapshotDataResResponseMetadata
- type DescribeLiveSnapshotDataResResponseMetadataError
- type DescribeLiveSnapshotDataResResult
- type DescribeLiveSnapshotDataResResultSnapshotDataListItem
- type DescribeLiveSnapshotDataResResultSnapshotDetailDataItem
- type DescribeLiveSnapshotDataResResultSnapshotDetailDataPropertiesItemsItem
- type DescribeLiveSourceBandwidthData
- type DescribeLiveSourceBandwidthDataBody
- type DescribeLiveSourceBandwidthDataBodyUserRegionListItem
- type DescribeLiveSourceBandwidthDataQuery
- type DescribeLiveSourceBandwidthDataReq
- type DescribeLiveSourceBandwidthDataRes
- type DescribeLiveSourceBandwidthDataResResponseMetadata
- type DescribeLiveSourceBandwidthDataResResponseMetadataError
- type DescribeLiveSourceBandwidthDataResResult
- type DescribeLiveSourceBandwidthDataResResultBandwidthDataListItem
- type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListItem
- type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem
- type DescribeLiveSourceBandwidthDataResResultUserRegionListItem
- type DescribeLiveSourceStreamMetrics
- type DescribeLiveSourceStreamMetricsBody
- type DescribeLiveSourceStreamMetricsQuery
- type DescribeLiveSourceStreamMetricsReq
- type DescribeLiveSourceStreamMetricsRes
- type DescribeLiveSourceStreamMetricsResResponseMetadata
- type DescribeLiveSourceStreamMetricsResResult
- type DescribeLiveSourceStreamMetricsResResultMetricListItem
- type DescribeLiveSourceTrafficData
- type DescribeLiveSourceTrafficDataBody
- type DescribeLiveSourceTrafficDataBodyUserRegionListItem
- type DescribeLiveSourceTrafficDataQuery
- type DescribeLiveSourceTrafficDataReq
- type DescribeLiveSourceTrafficDataRes
- type DescribeLiveSourceTrafficDataResResponseMetadata
- type DescribeLiveSourceTrafficDataResResponseMetadataError
- type DescribeLiveSourceTrafficDataResResult
- type DescribeLiveSourceTrafficDataResResultTrafficDataListItem
- type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListItem
- type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListPropertiesItemsItem
- type DescribeLiveSourceTrafficDataResResultUserRegionListItem
- type DescribeLiveStorageSpaceData
- type DescribeLiveStorageSpaceDataBody
- type DescribeLiveStorageSpaceDataQuery
- type DescribeLiveStorageSpaceDataReq
- type DescribeLiveStorageSpaceDataRes
- type DescribeLiveStorageSpaceDataResResponseMetadata
- type DescribeLiveStorageSpaceDataResResult
- type DescribeLiveStorageSpaceDataResResultStorageDataListItem
- type DescribeLiveStreamInfoByPage
- type DescribeLiveStreamInfoByPageBody
- type DescribeLiveStreamInfoByPageQuery
- type DescribeLiveStreamInfoByPageReq
- type DescribeLiveStreamInfoByPageRes
- type DescribeLiveStreamInfoByPageResResponseMetadata
- type DescribeLiveStreamInfoByPageResResponseMetadataError
- type DescribeLiveStreamInfoByPageResResult
- type DescribeLiveStreamInfoByPageResResultStreamInfoListItem
- type DescribeLiveStreamSessionData
- type DescribeLiveStreamSessionDataBody
- type DescribeLiveStreamSessionDataBodyRegionListItem
- type DescribeLiveStreamSessionDataQuery
- type DescribeLiveStreamSessionDataReq
- type DescribeLiveStreamSessionDataRes
- type DescribeLiveStreamSessionDataResResponseMetadata
- type DescribeLiveStreamSessionDataResResult
- type DescribeLiveStreamSessionDataResResultRegionListItem
- type DescribeLiveStreamSessionDataResResultSessionDataListItem
- type DescribeLiveStreamSessionDataResResultSessionDetailDataListItem
- type DescribeLiveStreamSessionDataResResultSessionDetailDataListPropertiesItemsItem
- type DescribeLiveStreamState
- type DescribeLiveStreamStateBody
- type DescribeLiveStreamStateQuery
- type DescribeLiveStreamStateReq
- type DescribeLiveStreamStateRes
- type DescribeLiveStreamStateResResponseMetadata
- type DescribeLiveStreamStateResResponseMetadataError
- type DescribeLiveStreamStateResResult
- type DescribeLiveTrafficData
- type DescribeLiveTrafficDataBody
- type DescribeLiveTrafficDataBodyRegionListItem
- type DescribeLiveTrafficDataBodyUserRegionListItem
- type DescribeLiveTrafficDataQuery
- type DescribeLiveTrafficDataReq
- type DescribeLiveTrafficDataRes
- type DescribeLiveTrafficDataResResponseMetadata
- type DescribeLiveTrafficDataResResult
- type DescribeLiveTrafficDataResResultRegionListItem
- type DescribeLiveTrafficDataResResultTrafficDataListItem
- type DescribeLiveTrafficDataResResultTrafficDetailDataListItem
- type DescribeLiveTrafficDataResResultTrafficDetailDataListPropertiesItemsItem
- type DescribeLiveTrafficDataResResultUserRegionListItem
- type DescribeLiveTranscodeData
- type DescribeLiveTranscodeDataBody
- type DescribeLiveTranscodeDataQuery
- type DescribeLiveTranscodeDataReq
- type DescribeLiveTranscodeDataRes
- type DescribeLiveTranscodeDataResResponseMetadata
- type DescribeLiveTranscodeDataResResponseMetadataError
- type DescribeLiveTranscodeDataResResult
- type DescribeLiveTranscodeDataResResultTranscodeDataListItem
- type DescribeLiveTranscodeInfoData
- type DescribeLiveTranscodeInfoDataBody
- type DescribeLiveTranscodeInfoDataQuery
- type DescribeLiveTranscodeInfoDataReq
- type DescribeLiveTranscodeInfoDataRes
- type DescribeLiveTranscodeInfoDataResResponseMetadata
- type DescribeLiveTranscodeInfoDataResResponseMetadataError
- type DescribeLiveTranscodeInfoDataResResult
- type DescribeLiveTranscodeInfoDataResResultPagination
- type DescribeLiveTranscodeInfoDataResResultTranscodeInfoDataListItem
- type DescribeRecordTaskFileHistory
- type DescribeRecordTaskFileHistoryBody
- type DescribeRecordTaskFileHistoryQuery
- type DescribeRecordTaskFileHistoryReq
- type DescribeRecordTaskFileHistoryRes
- type DescribeRecordTaskFileHistoryResResponseMetadata
- type DescribeRecordTaskFileHistoryResResponseMetadataError
- type DescribeRecordTaskFileHistoryResResult
- type DescribeRecordTaskFileHistoryResResultDataItem
- type DescribeRecordTaskFileHistoryResResultPagination
- type DescribeReferer
- type DescribeRefererBody
- type DescribeRefererQuery
- type DescribeRefererReq
- type DescribeRefererRes
- type DescribeRefererResResponseMetadata
- type DescribeRefererResResponseMetadataError
- type DescribeRefererResResult
- type DescribeRefererResResultRefererListItem
- type DescribeRefererResResultRefererListPropertiesItemsItem
- type DescribeRegionAccessRule
- type DescribeRegionAccessRuleBody
- type DescribeRegionAccessRuleQuery
- type DescribeRegionAccessRuleReq
- type DescribeRegionAccessRuleRes
- type DescribeRegionAccessRuleResResponseMetadata
- type DescribeRegionAccessRuleResResult
- type DescribeRegionAccessRuleResResultAccessRuleListsItem
- type DescribeRegionAccessRuleResResultAccessRuleListsItemRegionAccessRule
- type DescribeRelaySourceRewrite
- type DescribeRelaySourceRewriteBody
- type DescribeRelaySourceRewriteQuery
- type DescribeRelaySourceRewriteReq
- type DescribeRelaySourceRewriteRes
- type DescribeRelaySourceRewriteResResponseMetadata
- type DescribeRelaySourceRewriteResResult
- type DescribeRelaySourceRewriteResResultRelaySourceRewriteList
- type DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRule
- type DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRuleListItem
- type DescribeRelaySourceV3
- type DescribeRelaySourceV3Body
- type DescribeRelaySourceV3Query
- type DescribeRelaySourceV3Req
- type DescribeRelaySourceV3Res
- type DescribeRelaySourceV3ResResponseMetadata
- type DescribeRelaySourceV3ResResponseMetadataError
- type DescribeRelaySourceV3ResResult
- type DescribeRelaySourceV3ResResultRelaySourceConfigListItem
- type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsItem
- type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsServersItem
- type DescribeUserAgentAccessRule
- type DescribeUserAgentAccessRuleBody
- type DescribeUserAgentAccessRuleQuery
- type DescribeUserAgentAccessRuleReq
- type DescribeUserAgentAccessRuleRes
- type DescribeUserAgentAccessRuleResResponseMetadata
- type DescribeUserAgentAccessRuleResResult
- type DescribeUserAgentAccessRuleResResultUserAgentListItem
- type DescribeUserAgentAccessRuleResResultUserAgentListItemUaAccessRule
- type DisableDomain
- type DisableDomainBody
- type DisableDomainQuery
- type DisableDomainReq
- type DisableDomainRes
- type DisableDomainResResponseMetadata
- type DisableDomainResResponseMetadataError
- type EnableDomain
- type EnableDomainBody
- type EnableDomainQuery
- type EnableDomainReq
- type EnableDomainRes
- type EnableDomainResResponseMetadata
- type EnableDomainResResponseMetadataError
- type EnableHTTPHeaderConfig
- type EnableHTTPHeaderConfigBody
- type EnableHTTPHeaderConfigQuery
- type EnableHTTPHeaderConfigReq
- type EnableHTTPHeaderConfigRes
- type EnableHTTPHeaderConfigResResponseMetadata
- type Enum0
- type ForbidStream
- type ForbidStreamBody
- type ForbidStreamQuery
- type ForbidStreamReq
- type ForbidStreamRes
- type ForbidStreamResResponseMetadata
- type ForbidStreamResResponseMetadataError
- type GeneratePlayURL
- type GeneratePlayURLBody
- type GeneratePlayURLQuery
- type GeneratePlayURLReq
- type GeneratePlayURLRes
- type GeneratePlayURLResResponseMetadata
- type GeneratePlayURLResResponseMetadataError
- type GeneratePlayURLResResult
- type GeneratePlayURLResResultURLListItem
- type GeneratePushURL
- type GeneratePushURLBody
- type GeneratePushURLQuery
- type GeneratePushURLReq
- type GeneratePushURLRes
- type GeneratePushURLResResponseMetadata
- type GeneratePushURLResResponseMetadataError
- type GeneratePushURLResResult
- type GeneratePushURLResResultPushURLListDetailItem
- type GetCloudMixTaskDetail
- type GetCloudMixTaskDetailBody
- type GetCloudMixTaskDetailQuery
- type GetCloudMixTaskDetailReq
- type GetCloudMixTaskDetailRes
- type GetCloudMixTaskDetailResResponseMetadata
- type GetCloudMixTaskDetailResResult
- type GetCloudMixTaskDetailResResultData
- type GetHLSEncryptDataKey
- type GetHLSEncryptDataKeyBody
- type GetHLSEncryptDataKeyQuery
- type GetHLSEncryptDataKeyReq
- type GetHLSEncryptDataKeyRes
- type GetHLSEncryptDataKeyResResponseMetadata
- type GetHLSEncryptDataKeyResResult
- type GetLiveVideoQualityAnalysisTaskDetail
- type GetLiveVideoQualityAnalysisTaskDetailBody
- type GetLiveVideoQualityAnalysisTaskDetailQuery
- type GetLiveVideoQualityAnalysisTaskDetailReq
- type GetLiveVideoQualityAnalysisTaskDetailRes
- type GetLiveVideoQualityAnalysisTaskDetailResResponseMetadata
- type GetLiveVideoQualityAnalysisTaskDetailResResult
- type GetLiveVideoQualityAnalysisTaskDetailResResultTask
- type GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResult
- type GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResultVQScoreLiveItem
- type KillStream
- type KillStreamBody
- type KillStreamQuery
- type KillStreamReq
- type KillStreamRes
- type KillStreamResResponseMetadata
- type KillStreamResResponseMetadataError
- type ListBindEncryptDRM
- type ListBindEncryptDRMBody
- type ListBindEncryptDRMQuery
- type ListBindEncryptDRMReq
- type ListBindEncryptDRMRes
- type ListBindEncryptDRMResResponseMetadata
- type ListBindEncryptDRMResResult
- type ListBindEncryptDRMResResultDRMBindingListItem
- type ListCertV2
- type ListCertV2Body
- type ListCertV2Query
- type ListCertV2Req
- type ListCertV2Res
- type ListCertV2ResResponseMetadata
- type ListCertV2ResResponseMetadataError
- type ListCertV2ResResult
- type ListCertV2ResResultCertListItem
- type ListCloudMixTask
- type ListCloudMixTaskBody
- type ListCloudMixTaskQuery
- type ListCloudMixTaskReq
- type ListCloudMixTaskRes
- type ListCloudMixTaskResResponseMetadata
- type ListCloudMixTaskResResult
- type ListCloudMixTaskResResultData
- type ListCloudMixTaskResResultDataResultItem
- type ListCloudMixTaskResResultDataResultItemCreatedAt
- type ListCloudMixTaskResResultDataResultItemStoppedAt
- type ListCloudMixTaskResResultDataResultItemUpdatedAt
- type ListCommonTransPresetDetail
- type ListCommonTransPresetDetailBody
- type ListCommonTransPresetDetailQuery
- type ListCommonTransPresetDetailReq
- type ListCommonTransPresetDetailRes
- type ListCommonTransPresetDetailResResponseMetadata
- type ListCommonTransPresetDetailResResponseMetadataError
- type ListCommonTransPresetDetailResResult
- type ListCommonTransPresetDetailResResultNarrowBandHDPresetDetailItem
- type ListCommonTransPresetDetailResResultStandardPresetDetailItem
- type ListDomainDetail
- type ListDomainDetailBody
- type ListDomainDetailQuery
- type ListDomainDetailReq
- type ListDomainDetailRes
- type ListDomainDetailResResponseMetadata
- type ListDomainDetailResResponseMetadataError
- type ListDomainDetailResResult
- type ListDomainDetailResResultDomainListItem
- type ListDomainDetailResResultDomainListPropertiesItemsItem
- type ListLiveVideoQualityAnalysisTasks
- type ListLiveVideoQualityAnalysisTasksBody
- type ListLiveVideoQualityAnalysisTasksQuery
- type ListLiveVideoQualityAnalysisTasksReq
- type ListLiveVideoQualityAnalysisTasksRes
- type ListLiveVideoQualityAnalysisTasksResResponseMetadata
- type ListLiveVideoQualityAnalysisTasksResResult
- type ListLiveVideoQualityAnalysisTasksResResultTasksItem
- type ListPullToPushGroup
- type ListPullToPushGroupBody
- type ListPullToPushGroupQuery
- type ListPullToPushGroupReq
- type ListPullToPushGroupRes
- type ListPullToPushGroupResResponseMetadata
- type ListPullToPushGroupResResult
- type ListPullToPushGroupResResultListItem
- type ListPullToPushGroupResResultListPropertiesItemsItem
- type ListPullToPushTask
- type ListPullToPushTaskBody
- type ListPullToPushTaskQuery
- type ListPullToPushTaskReq
- type ListPullToPushTaskRes
- type ListPullToPushTaskResResponseMetadata
- type ListPullToPushTaskResResponseMetadataError
- type ListPullToPushTaskResResult
- type ListPullToPushTaskResResultListItem
- type ListPullToPushTaskResResultListItemWatermark
- type ListPullToPushTaskResResultPagination
- type ListPullToPushTaskV2
- type ListPullToPushTaskV2Body
- type ListPullToPushTaskV2Query
- type ListPullToPushTaskV2Req
- type ListPullToPushTaskV2Res
- type ListPullToPushTaskV2ResResponseMetadata
- type ListPullToPushTaskV2ResResponseMetadataError
- type ListPullToPushTaskV2ResResult
- type ListPullToPushTaskV2ResResultListItem
- type ListPullToPushTaskV2ResResultListItemWatermark
- type ListPullToPushTaskV2ResResultPagination
- type ListTimeShiftPresetV2
- type ListTimeShiftPresetV2Body
- type ListTimeShiftPresetV2Query
- type ListTimeShiftPresetV2Req
- type ListTimeShiftPresetV2Res
- type ListTimeShiftPresetV2ResResponseMetadata
- type ListTimeShiftPresetV2ResResponseMetadataError
- type ListTimeShiftPresetV2ResResult
- type ListTimeShiftPresetV2ResResultListItem
- type ListVhostRecordPresetV2
- type ListVhostRecordPresetV2Body
- type ListVhostRecordPresetV2Query
- type ListVhostRecordPresetV2Req
- type ListVhostRecordPresetV2Res
- type ListVhostRecordPresetV2ResResponseMetadata
- type ListVhostRecordPresetV2ResResponseMetadataError
- type ListVhostRecordPresetV2ResResult
- type ListVhostRecordPresetV2ResResultPresetListItem
- type ListVhostRecordPresetV2ResResultPresetListItemSlicePresetV2
- type ListVhostSnapshotPreset
- type ListVhostSnapshotPresetBody
- type ListVhostSnapshotPresetQuery
- type ListVhostSnapshotPresetReq
- type ListVhostSnapshotPresetRes
- type ListVhostSnapshotPresetResResponseMetadata
- type ListVhostSnapshotPresetResResponseMetadataError
- type ListVhostSnapshotPresetResResult
- type ListVhostSnapshotPresetResResultPresetListItem
- type ListVhostSnapshotPresetResResultPresetListItemSlicePreset
- type ListVhostSubtitleTranscodePreset
- type ListVhostSubtitleTranscodePresetBody
- type ListVhostSubtitleTranscodePresetQuery
- type ListVhostSubtitleTranscodePresetReq
- type ListVhostSubtitleTranscodePresetRes
- type ListVhostSubtitleTranscodePresetResResponseMetadata
- type ListVhostSubtitleTranscodePresetResResult
- type ListVhostSubtitleTranscodePresetResResultPresetListItem
- type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePreset
- type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePresetTargetLanguageItemBorder
- type ListVhostTransCodePreset
- type ListVhostTransCodePresetBody
- type ListVhostTransCodePresetQuery
- type ListVhostTransCodePresetReq
- type ListVhostTransCodePresetRes
- type ListVhostTransCodePresetResResponseMetadata
- type ListVhostTransCodePresetResResponseMetadataError
- type ListVhostTransCodePresetResResult
- type ListVhostTransCodePresetResResultAllPresetListItem
- type ListVhostTransCodePresetResResultAllPresetListItemTranscodePreset
- type ListVhostTransCodePresetResResultCommonPresetListItem
- type ListVhostTransCodePresetResResultCommonPresetListItemTranscodePreset
- type ListVhostTransCodePresetResResultCustomizePresetListItem
- type ListVhostTransCodePresetResResultCustomizePresetListItemTranscodePreset
- type ListVhostWatermarkPreset
- type ListVhostWatermarkPresetBody
- type ListVhostWatermarkPresetQuery
- type ListVhostWatermarkPresetReq
- type ListVhostWatermarkPresetRes
- type ListVhostWatermarkPresetResResponseMetadata
- type ListVhostWatermarkPresetResResponseMetadataError
- type ListVhostWatermarkPresetResResult
- type ListVhostWatermarkPresetResResultWatermarkErrMsgListItem
- type ListVhostWatermarkPresetResResultWatermarkPresetListItem
- type ListWatermarkPreset
- type ListWatermarkPresetBody
- type ListWatermarkPresetQuery
- type ListWatermarkPresetReq
- type ListWatermarkPresetRes
- type ListWatermarkPresetResResponseMetadata
- type ListWatermarkPresetResResponseMetadataError
- type ListWatermarkPresetResResult
- type ListWatermarkPresetResResultPreset
- type Live
- func (c *Live) BindCert(arg *BindCertBody) (*BindCertRes, error)
- func (c *Live) BindEncryptDRM(arg *BindEncryptDRMBody) (*BindEncryptDRMRes, error)
- func (c *Live) CreateCert(arg *CreateCertBody) (*CreateCertRes, error)
- func (c *Live) CreateCloudMixTask(arg *CreateCloudMixTaskBody) (*CreateCloudMixTaskRes, error)
- func (c *Live) CreateDomainV2(arg *CreateDomainV2Body) (*CreateDomainV2Res, error)
- func (c *Live) CreateLiveVideoQualityAnalysisTask(arg *CreateLiveVideoQualityAnalysisTaskBody) (*CreateLiveVideoQualityAnalysisTaskRes, error)
- func (c *Live) CreatePullToPushGroup(arg *CreatePullToPushGroupBody) (*CreatePullToPushGroupRes, error)
- func (c *Live) CreatePullToPushTask(arg *CreatePullToPushTaskBody) (*CreatePullToPushTaskRes, error)
- func (c *Live) CreateRecordPresetV2(arg *CreateRecordPresetV2Body) (*CreateRecordPresetV2Res, error)
- func (c *Live) CreateSnapshotPreset(arg *CreateSnapshotPresetBody) (*CreateSnapshotPresetRes, error)
- func (c *Live) CreateSubtitleTranscodePreset(arg *CreateSubtitleTranscodePresetBody) (*CreateSubtitleTranscodePresetRes, error)
- func (c *Live) CreateTimeShiftPresetV2(arg *CreateTimeShiftPresetV2Body) (*CreateTimeShiftPresetV2Res, error)
- func (c *Live) CreateTranscodePreset(arg *CreateTranscodePresetBody) (*CreateTranscodePresetRes, error)
- func (c *Live) CreateWatermarkPreset(arg *CreateWatermarkPresetBody) (*CreateWatermarkPresetRes, error)
- func (c *Live) DeleteCMAFConfig(arg *DeleteCMAFConfigBody) (*DeleteCMAFConfigRes, error)
- func (c *Live) DeleteCallback(arg *DeleteCallbackBody) (*DeleteCallbackRes, error)
- func (c *Live) DeleteCert(arg *DeleteCertBody) (*DeleteCertRes, error)
- func (c *Live) DeleteCloudMixTask(arg *DeleteCloudMixTaskBody) (*DeleteCloudMixTaskRes, error)
- func (c *Live) DeleteClusterRateLimit(arg *DeleteClusterRateLimitBody) (*DeleteClusterRateLimitRes, error)
- func (c *Live) DeleteDomain(arg *DeleteDomainBody) (*DeleteDomainRes, error)
- func (c *Live) DeleteFormatAccessRule(arg *DeleteFormatAccessRuleBody) (*DeleteFormatAccessRuleRes, error)
- func (c *Live) DeleteHLSConfig(arg *DeleteHLSConfigBody) (*DeleteHLSConfigRes, error)
- func (c *Live) DeleteHTTPHeaderConfig(arg *DeleteHTTPHeaderConfigBody) (*DeleteHTTPHeaderConfigRes, error)
- func (c *Live) DeleteIPAccessRule(arg *DeleteIPAccessRuleBody) (*DeleteIPAccessRuleRes, error)
- func (c *Live) DeleteLatencyConfig(arg *DeleteLatencyConfigBody) (*DeleteLatencyConfigRes, error)
- func (c *Live) DeleteLiveVideoQualityAnalysisTask(arg *DeleteLiveVideoQualityAnalysisTaskBody) (*DeleteLiveVideoQualityAnalysisTaskRes, error)
- func (c *Live) DeletePullToPushGroup(arg *DeletePullToPushGroupBody) (*DeletePullToPushGroupRes, error)
- func (c *Live) DeletePullToPushTask(arg *DeletePullToPushTaskBody) (*DeletePullToPushTaskRes, error)
- func (c *Live) DeleteRecordPreset(arg *DeleteRecordPresetBody) (*DeleteRecordPresetRes, error)
- func (c *Live) DeleteReferer(arg *DeleteRefererBody) (*DeleteRefererRes, error)
- func (c *Live) DeleteRegionAccessRule(arg *DeleteRegionAccessRuleBody) (*DeleteRegionAccessRuleRes, error)
- func (c *Live) DeleteRelaySourceRewrite(arg *DeleteRelaySourceRewriteBody) (*DeleteRelaySourceRewriteRes, error)
- func (c *Live) DeleteRelaySourceV3(arg *DeleteRelaySourceV3Body) (*DeleteRelaySourceV3Res, error)
- func (c *Live) DeleteSnapshotPreset(arg *DeleteSnapshotPresetBody) (*DeleteSnapshotPresetRes, error)
- func (c *Live) DeleteSubtitleTranscodePreset(arg *DeleteSubtitleTranscodePresetBody) (*DeleteSubtitleTranscodePresetRes, error)
- func (c *Live) DeleteTimeShiftPresetV2(arg *DeleteTimeShiftPresetV2Body) (*DeleteTimeShiftPresetV2Res, error)
- func (c *Live) DeleteTranscodePreset(arg *DeleteTranscodePresetBody) (*DeleteTranscodePresetRes, error)
- func (c *Live) DeleteUserAgentAccessRule(arg *DeleteUserAgentAccessRuleBody) (*DeleteUserAgentAccessRuleRes, error)
- func (c *Live) DeleteWatermarkPreset(arg *DeleteWatermarkPresetBody) (*DeleteWatermarkPresetRes, error)
- func (c *Live) DescribeAuth(arg *DescribeAuthBody) (*DescribeAuthRes, error)
- func (c *Live) DescribeCDNSnapshotHistory(arg *DescribeCDNSnapshotHistoryBody) (*DescribeCDNSnapshotHistoryRes, error)
- func (c *Live) DescribeCMAFConfig(arg *DescribeCMAFConfigBody) (*DescribeCMAFConfigRes, error)
- func (c *Live) DescribeCallback(arg *DescribeCallbackBody) (*DescribeCallbackRes, error)
- func (c *Live) DescribeCertDRM(arg *DescribeCertDRMQuery) (*DescribeCertDRMRes, error)
- func (c *Live) DescribeCertDetailSecretV2(arg *DescribeCertDetailSecretV2Body) (*DescribeCertDetailSecretV2Res, error)
- func (c *Live) DescribeClosedStreamInfoByPage(arg *DescribeClosedStreamInfoByPageQuery) (*DescribeClosedStreamInfoByPageRes, error)
- func (c *Live) DescribeClusterRateLimit(arg *DescribeClusterRateLimitBody) (*DescribeClusterRateLimitRes, error)
- func (c *Live) DescribeDomain(arg *DescribeDomainBody) (*DescribeDomainRes, error)
- func (c *Live) DescribeEncryptDRM() (*DescribeEncryptDRMRes, error)
- func (c *Live) DescribeEncryptHLS() (*DescribeEncryptHLSRes, error)
- func (c *Live) DescribeForbiddenStreamInfoByPage(arg *DescribeForbiddenStreamInfoByPageQuery) (*DescribeForbiddenStreamInfoByPageRes, error)
- func (c *Live) DescribeFormatAccessRule(arg *DescribeFormatAccessRuleBody) (*DescribeFormatAccessRuleRes, error)
- func (c *Live) DescribeHLSConfig(arg *DescribeHLSConfigBody) (*DescribeHLSConfigRes, error)
- func (c *Live) DescribeHTTPHeaderConfig(arg *DescribeHTTPHeaderConfigBody) (*DescribeHTTPHeaderConfigRes, error)
- func (c *Live) DescribeIPAccessRule(arg *DescribeIPAccessRuleBody) (*DescribeIPAccessRuleRes, error)
- func (c *Live) DescribeLatencyConfig(arg *DescribeLatencyConfigBody) (*DescribeLatencyConfigRes, error)
- func (c *Live) DescribeLicenseDRM(arg *DescribeLicenseDRMQuery) (*DescribeLicenseDRMRes, error)
- func (c *Live) DescribeLiveASRDurationData(arg *DescribeLiveASRDurationDataBody) (*DescribeLiveASRDurationDataRes, error)
- func (c *Live) DescribeLiveBandwidthData(arg *DescribeLiveBandwidthDataBody) (*DescribeLiveBandwidthDataRes, error)
- func (c *Live) DescribeLiveBatchPushStreamMetrics(arg *DescribeLiveBatchPushStreamMetricsBody) (*DescribeLiveBatchPushStreamMetricsRes, error)
- func (c *Live) DescribeLiveISPData() (*DescribeLiveISPDataRes, error)
- func (c *Live) DescribeLiveLogData(arg *DescribeLiveLogDataBody) (*DescribeLiveLogDataRes, error)
- func (c *Live) DescribeLiveMetricBandwidthData(arg *DescribeLiveMetricBandwidthDataBody) (*DescribeLiveMetricBandwidthDataRes, error)
- func (c *Live) DescribeLiveMetricTrafficData(arg *DescribeLiveMetricTrafficDataBody) (*DescribeLiveMetricTrafficDataRes, error)
- func (c *Live) DescribeLiveP95PeakBandwidthData(arg *DescribeLiveP95PeakBandwidthDataBody) (*DescribeLiveP95PeakBandwidthDataRes, error)
- func (c *Live) DescribeLivePlayStatusCodeData(arg *DescribeLivePlayStatusCodeDataBody) (*DescribeLivePlayStatusCodeDataRes, error)
- func (c *Live) DescribeLivePullToPushBandwidthData(arg *DescribeLivePullToPushBandwidthDataBody) (*DescribeLivePullToPushBandwidthDataRes, error)
- func (c *Live) DescribeLivePullToPushData(arg *DescribeLivePullToPushDataBody) (*DescribeLivePullToPushDataRes, error)
- func (c *Live) DescribeLivePushStreamInfoData(arg *DescribeLivePushStreamInfoDataBody) (*DescribeLivePushStreamInfoDataRes, error)
- func (c *Live) DescribeLivePushStreamMetrics(arg *DescribeLivePushStreamMetricsBody) (*DescribeLivePushStreamMetricsRes, error)
- func (c *Live) DescribeLiveRecordData(arg *DescribeLiveRecordDataBody) (*DescribeLiveRecordDataRes, error)
- func (c *Live) DescribeLiveRegionData() (*DescribeLiveRegionDataRes, error)
- func (c *Live) DescribeLiveSnapshotData(arg *DescribeLiveSnapshotDataBody) (*DescribeLiveSnapshotDataRes, error)
- func (c *Live) DescribeLiveSourceBandwidthData(arg *DescribeLiveSourceBandwidthDataBody) (*DescribeLiveSourceBandwidthDataRes, error)
- func (c *Live) DescribeLiveSourceStreamMetrics(arg *DescribeLiveSourceStreamMetricsBody) (*DescribeLiveSourceStreamMetricsRes, error)
- func (c *Live) DescribeLiveSourceTrafficData(arg *DescribeLiveSourceTrafficDataBody) (*DescribeLiveSourceTrafficDataRes, error)
- func (c *Live) DescribeLiveStorageSpaceData(arg *DescribeLiveStorageSpaceDataBody) (*DescribeLiveStorageSpaceDataRes, error)
- func (c *Live) DescribeLiveStreamInfoByPage(arg *DescribeLiveStreamInfoByPageQuery) (*DescribeLiveStreamInfoByPageRes, error)
- func (c *Live) DescribeLiveStreamSessionData(arg *DescribeLiveStreamSessionDataBody) (*DescribeLiveStreamSessionDataRes, error)
- func (c *Live) DescribeLiveStreamState(arg *DescribeLiveStreamStateQuery) (*DescribeLiveStreamStateRes, error)
- func (c *Live) DescribeLiveTrafficData(arg *DescribeLiveTrafficDataBody) (*DescribeLiveTrafficDataRes, error)
- func (c *Live) DescribeLiveTranscodeData(arg *DescribeLiveTranscodeDataBody) (*DescribeLiveTranscodeDataRes, error)
- func (c *Live) DescribeLiveTranscodeInfoData(arg *DescribeLiveTranscodeInfoDataBody) (*DescribeLiveTranscodeInfoDataRes, error)
- func (c *Live) DescribeRecordTaskFileHistory(arg *DescribeRecordTaskFileHistoryBody) (*DescribeRecordTaskFileHistoryRes, error)
- func (c *Live) DescribeReferer(arg *DescribeRefererBody) (*DescribeRefererRes, error)
- func (c *Live) DescribeRegionAccessRule(arg *DescribeRegionAccessRuleBody) (*DescribeRegionAccessRuleRes, error)
- func (c *Live) DescribeRelaySourceRewrite(arg *DescribeRelaySourceRewriteBody) (*DescribeRelaySourceRewriteRes, error)
- func (c *Live) DescribeRelaySourceV3(arg *DescribeRelaySourceV3Body) (*DescribeRelaySourceV3Res, error)
- func (c *Live) DescribeUserAgentAccessRule(arg *DescribeUserAgentAccessRuleBody) (*DescribeUserAgentAccessRuleRes, error)
- func (c *Live) DisableDomain(arg *DisableDomainBody) (*DisableDomainRes, error)
- func (c *Live) EnableDomain(arg *EnableDomainBody) (*EnableDomainRes, error)
- func (c *Live) EnableHTTPHeaderConfig(arg *EnableHTTPHeaderConfigBody) (*EnableHTTPHeaderConfigRes, error)
- func (c *Live) ForbidStream(arg *ForbidStreamBody) (*ForbidStreamRes, error)
- func (c *Live) GeneratePlayURL(arg *GeneratePlayURLBody) (*GeneratePlayURLRes, error)
- func (c *Live) GeneratePushURL(arg *GeneratePushURLBody) (*GeneratePushURLRes, error)
- func (c *Live) GetCloudMixTaskDetail(arg *GetCloudMixTaskDetailBody) (*GetCloudMixTaskDetailRes, error)
- func (c *Live) GetHLSEncryptDataKey(arg *GetHLSEncryptDataKeyQuery) (*GetHLSEncryptDataKeyRes, error)
- func (c *Live) GetLiveVideoQualityAnalysisTaskDetail(arg *GetLiveVideoQualityAnalysisTaskDetailBody) (*GetLiveVideoQualityAnalysisTaskDetailRes, error)
- func (c *Live) KillStream(arg *KillStreamBody) (*KillStreamRes, error)
- func (c *Live) ListBindEncryptDRM(arg *ListBindEncryptDRMBody) (*ListBindEncryptDRMRes, error)
- func (c *Live) ListCertV2(arg *ListCertV2Body) (*ListCertV2Res, error)
- func (c *Live) ListCloudMixTask(arg *ListCloudMixTaskBody) (*ListCloudMixTaskRes, error)
- func (c *Live) ListCommonTransPresetDetail(arg *ListCommonTransPresetDetailBody) (*ListCommonTransPresetDetailRes, error)
- func (c *Live) ListDomainDetail(arg *ListDomainDetailBody) (*ListDomainDetailRes, error)
- func (c *Live) ListLiveVideoQualityAnalysisTasks(arg *ListLiveVideoQualityAnalysisTasksBody) (*ListLiveVideoQualityAnalysisTasksRes, error)
- func (c *Live) ListPullToPushGroup(arg *ListPullToPushGroupBody) (*ListPullToPushGroupRes, error)
- func (c *Live) ListPullToPushTask(arg *ListPullToPushTaskQuery) (*ListPullToPushTaskRes, error)
- func (c *Live) ListPullToPushTaskV2(arg *ListPullToPushTaskV2Body) (*ListPullToPushTaskV2Res, error)
- func (c *Live) ListTimeShiftPresetV2(arg *ListTimeShiftPresetV2Body) (*ListTimeShiftPresetV2Res, error)
- func (c *Live) ListVhostRecordPresetV2(arg *ListVhostRecordPresetV2Body) (*ListVhostRecordPresetV2Res, error)
- func (c *Live) ListVhostSnapshotPreset(arg *ListVhostSnapshotPresetBody) (*ListVhostSnapshotPresetRes, error)
- func (c *Live) ListVhostSubtitleTranscodePreset(arg *ListVhostSubtitleTranscodePresetBody) (*ListVhostSubtitleTranscodePresetRes, error)
- func (c *Live) ListVhostTransCodePreset(arg *ListVhostTransCodePresetBody) (*ListVhostTransCodePresetRes, error)
- func (c *Live) ListVhostWatermarkPreset(arg *ListVhostWatermarkPresetBody) (*ListVhostWatermarkPresetRes, error)
- func (c *Live) ListWatermarkPreset(arg *ListWatermarkPresetBody) (*ListWatermarkPresetRes, error)
- func (c *Live) RestartPullToPushTask(arg *RestartPullToPushTaskBody) (*RestartPullToPushTaskRes, error)
- func (c *Live) ResumeStream(arg *ResumeStreamBody) (*ResumeStreamRes, error)
- func (c *Live) StopPullToPushTask(arg *StopPullToPushTaskBody) (*StopPullToPushTaskRes, error)
- func (c *Live) UnBindEncryptDRM(arg *UnBindEncryptDRMBody) (*UnBindEncryptDRMRes, error)
- func (c *Live) UnbindCert(arg *UnbindCertBody) (*UnbindCertRes, error)
- func (c *Live) UpdateAuthKey(arg *UpdateAuthKeyBody) (*UpdateAuthKeyRes, error)
- func (c *Live) UpdateCMAFConfig(arg *UpdateCMAFConfigBody) (*UpdateCMAFConfigRes, error)
- func (c *Live) UpdateCallback(arg *UpdateCallbackBody) (*UpdateCallbackRes, error)
- func (c *Live) UpdateCloudMixTask(arg *UpdateCloudMixTaskBody) (*UpdateCloudMixTaskRes, error)
- func (c *Live) UpdateClusterRateLimit(arg *UpdateClusterRateLimitBody) (*UpdateClusterRateLimitRes, error)
- func (c *Live) UpdateDomainVhost(arg *UpdateDomainVhostBody) (*UpdateDomainVhostRes, error)
- func (c *Live) UpdateEncryptDRM(arg *UpdateEncryptDRMBody) (*UpdateEncryptDRMRes, error)
- func (c *Live) UpdateEncryptHLS(arg *UpdateEncryptHLSBody) (*UpdateEncryptHLSRes, error)
- func (c *Live) UpdateFormatAccessRule(arg *UpdateFormatAccessRuleBody) (*UpdateFormatAccessRuleRes, error)
- func (c *Live) UpdateHLSConfig(arg *UpdateHLSConfigBody) (*UpdateHLSConfigRes, error)
- func (c *Live) UpdateHTTPHeaderConfig(arg *UpdateHTTPHeaderConfigBody) (*UpdateHTTPHeaderConfigRes, error)
- func (c *Live) UpdateIPAccessRule(arg *UpdateIPAccessRuleBody) (*UpdateIPAccessRuleRes, error)
- func (c *Live) UpdateLatencyConfig(arg *UpdateLatencyConfigBody) (*UpdateLatencyConfigRes, error)
- func (c *Live) UpdatePullToPushTask(arg *UpdatePullToPushTaskBody) (*UpdatePullToPushTaskRes, error)
- func (c *Live) UpdateRecordPresetV2(arg *UpdateRecordPresetV2Body) (*UpdateRecordPresetV2Res, error)
- func (c *Live) UpdateReferer(arg *UpdateRefererBody) (*UpdateRefererRes, error)
- func (c *Live) UpdateRegionAccessRule(arg *UpdateRegionAccessRuleBody) (*UpdateRegionAccessRuleRes, error)
- func (c *Live) UpdateRelaySourceRewrite(arg *UpdateRelaySourceRewriteBody) (*UpdateRelaySourceRewriteRes, error)
- func (c *Live) UpdateRelaySourceV3(arg *UpdateRelaySourceV3Body) (*UpdateRelaySourceV3Res, error)
- func (c *Live) UpdateSnapshotPreset(arg *UpdateSnapshotPresetBody) (*UpdateSnapshotPresetRes, error)
- func (c *Live) UpdateSubtitleTranscodePreset(arg *UpdateSubtitleTranscodePresetBody) (*UpdateSubtitleTranscodePresetRes, error)
- func (c *Live) UpdateTimeShiftPresetV2(arg *UpdateTimeShiftPresetV2Body) (*UpdateTimeShiftPresetV2Res, error)
- func (c *Live) UpdateTranscodePreset(arg *UpdateTranscodePresetBody) (*UpdateTranscodePresetRes, error)
- func (c *Live) UpdateUserAgentAccessRule(arg *UpdateUserAgentAccessRuleBody) (*UpdateUserAgentAccessRuleRes, error)
- func (c *Live) UpdateWatermarkPreset(arg *UpdateWatermarkPresetBody) (*UpdateWatermarkPresetRes, error)
- type RestartPullToPushTask
- type RestartPullToPushTaskBody
- type RestartPullToPushTaskQuery
- type RestartPullToPushTaskReq
- type RestartPullToPushTaskRes
- type RestartPullToPushTaskResResponseMetadata
- type RestartPullToPushTaskResResponseMetadataError
- type ResumeStream
- type ResumeStreamBody
- type ResumeStreamQuery
- type ResumeStreamReq
- type ResumeStreamRes
- type ResumeStreamResResponseMetadata
- type ResumeStreamResResponseMetadataError
- type StopPullToPushTask
- type StopPullToPushTaskBody
- type StopPullToPushTaskQuery
- type StopPullToPushTaskReq
- type StopPullToPushTaskRes
- type StopPullToPushTaskResResponseMetadata
- type StopPullToPushTaskResResponseMetadataError
- type UnBindEncryptDRM
- type UnBindEncryptDRMBody
- type UnBindEncryptDRMQuery
- type UnBindEncryptDRMReq
- type UnBindEncryptDRMRes
- type UnBindEncryptDRMResResponseMetadata
- type UnbindCert
- type UnbindCertBody
- type UnbindCertQuery
- type UnbindCertReq
- type UnbindCertRes
- type UnbindCertResResponseMetadata
- type UnbindCertResResponseMetadataError
- type UpdateAuthKey
- type UpdateAuthKeyBody
- type UpdateAuthKeyBodyAuthDetailListItem
- type UpdateAuthKeyQuery
- type UpdateAuthKeyReq
- type UpdateAuthKeyRes
- type UpdateAuthKeyResResponseMetadata
- type UpdateAuthKeyResResponseMetadataError
- type UpdateCMAFConfig
- type UpdateCMAFConfigBody
- type UpdateCMAFConfigQuery
- type UpdateCMAFConfigReq
- type UpdateCMAFConfigRes
- type UpdateCMAFConfigResResponseMetadata
- type UpdateCallback
- type UpdateCallbackBody
- type UpdateCallbackBodyCallbackDetailListItem
- type UpdateCallbackQuery
- type UpdateCallbackReq
- type UpdateCallbackRes
- type UpdateCallbackResResponseMetadata
- type UpdateCallbackResResponseMetadataError
- type UpdateCloudMixTask
- type UpdateCloudMixTaskBody
- type UpdateCloudMixTaskBodyMixedRules
- type UpdateCloudMixTaskBodyMixedRulesInputLayout
- type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItem
- type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout
- type UpdateCloudMixTaskBodyMixedRulesInputLayoutScene
- type UpdateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem
- type UpdateCloudMixTaskBodyMixedRulesInputSourceItem
- type UpdateCloudMixTaskBodyMixedRulesOutput
- type UpdateCloudMixTaskBodyMixedRulesOutputAudio
- type UpdateCloudMixTaskBodyMixedRulesOutputVideo
- type UpdateCloudMixTaskQuery
- type UpdateCloudMixTaskReq
- type UpdateCloudMixTaskRes
- type UpdateCloudMixTaskResResponseMetadata
- type UpdateCloudMixTaskResResult
- type UpdateCloudMixTaskResResultData
- type UpdateClusterRateLimit
- type UpdateClusterRateLimitBody
- type UpdateClusterRateLimitQuery
- type UpdateClusterRateLimitReq
- type UpdateClusterRateLimitRes
- type UpdateClusterRateLimitResResponseMetadata
- type UpdateDomainVhost
- type UpdateDomainVhostBody
- type UpdateDomainVhostQuery
- type UpdateDomainVhostReq
- type UpdateDomainVhostRes
- type UpdateDomainVhostResResponseMetadata
- type UpdateDomainVhostResResponseMetadataError
- type UpdateEncryptDRM
- type UpdateEncryptDRMBody
- type UpdateEncryptDRMQuery
- type UpdateEncryptDRMReq
- type UpdateEncryptDRMRes
- type UpdateEncryptDRMResResponseMetadata
- type UpdateEncryptHLS
- type UpdateEncryptHLSBody
- type UpdateEncryptHLSQuery
- type UpdateEncryptHLSReq
- type UpdateEncryptHLSRes
- type UpdateEncryptHLSResResponseMetadata
- type UpdateFormatAccessRule
- type UpdateFormatAccessRuleBody
- type UpdateFormatAccessRuleBodyFormatAccessRule
- type UpdateFormatAccessRuleQuery
- type UpdateFormatAccessRuleReq
- type UpdateFormatAccessRuleRes
- type UpdateFormatAccessRuleResResponseMetadata
- type UpdateHLSConfig
- type UpdateHLSConfigBody
- type UpdateHLSConfigQuery
- type UpdateHLSConfigReq
- type UpdateHLSConfigRes
- type UpdateHLSConfigResResponseMetadata
- type UpdateHTTPHeaderConfig
- type UpdateHTTPHeaderConfigBody
- type UpdateHTTPHeaderConfigBodyHeaderConfigListItem
- type UpdateHTTPHeaderConfigQuery
- type UpdateHTTPHeaderConfigReq
- type UpdateHTTPHeaderConfigRes
- type UpdateHTTPHeaderConfigResResponseMetadata
- type UpdateIPAccessRule
- type UpdateIPAccessRuleBody
- type UpdateIPAccessRuleBodyIPAccessRule
- type UpdateIPAccessRuleQuery
- type UpdateIPAccessRuleReq
- type UpdateIPAccessRuleRes
- type UpdateIPAccessRuleResResponseMetadata
- type UpdateLatencyConfig
- type UpdateLatencyConfigBody
- type UpdateLatencyConfigQuery
- type UpdateLatencyConfigReq
- type UpdateLatencyConfigRes
- type UpdateLatencyConfigResResponseMetadata
- type UpdatePullToPushTask
- type UpdatePullToPushTaskBody
- type UpdatePullToPushTaskBodyVodSrcAddrsItem
- type UpdatePullToPushTaskBodyWatermark
- type UpdatePullToPushTaskQuery
- type UpdatePullToPushTaskReq
- type UpdatePullToPushTaskRes
- type UpdatePullToPushTaskResResponseMetadata
- type UpdatePullToPushTaskResResponseMetadataError
- type UpdateRecordPresetV2
- type UpdateRecordPresetV2Body
- type UpdateRecordPresetV2BodyRecordPresetConfig
- type UpdateRecordPresetV2BodyRecordPresetConfigFlvParam
- type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam
- type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam
- type UpdateRecordPresetV2BodyRecordPresetConfigHlsParam
- type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam
- type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam
- type UpdateRecordPresetV2BodyRecordPresetConfigMp4Param
- type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam
- type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam
- type UpdateRecordPresetV2Query
- type UpdateRecordPresetV2Req
- type UpdateRecordPresetV2Res
- type UpdateRecordPresetV2ResResponseMetadata
- type UpdateRecordPresetV2ResResponseMetadataError
- type UpdateReferer
- type UpdateRefererBody
- type UpdateRefererBodyRefererInfoListItem
- type UpdateRefererQuery
- type UpdateRefererReq
- type UpdateRefererRes
- type UpdateRefererResResponseMetadata
- type UpdateRefererResResponseMetadataError
- type UpdateRegionAccessRule
- type UpdateRegionAccessRuleBody
- type UpdateRegionAccessRuleBodyRegionAccessRule
- type UpdateRegionAccessRuleQuery
- type UpdateRegionAccessRuleReq
- type UpdateRegionAccessRuleRes
- type UpdateRegionAccessRuleResResponseMetadata
- type UpdateRelaySourceRewrite
- type UpdateRelaySourceRewriteBody
- type UpdateRelaySourceRewriteBodyRewriteRule
- type UpdateRelaySourceRewriteBodyRewriteRuleListItem
- type UpdateRelaySourceRewriteQuery
- type UpdateRelaySourceRewriteReq
- type UpdateRelaySourceRewriteRes
- type UpdateRelaySourceRewriteResResponseMetadata
- type UpdateRelaySourceV3
- type UpdateRelaySourceV3Body
- type UpdateRelaySourceV3BodyGroupDetailsItem
- type UpdateRelaySourceV3BodyGroupDetailsItemAuthParams
- type UpdateRelaySourceV3BodyGroupDetailsItemServersItemOutboundConfig
- type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsItem
- type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListItem
- type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListPropertiesItemsItem
- type UpdateRelaySourceV3Query
- type UpdateRelaySourceV3Req
- type UpdateRelaySourceV3Res
- type UpdateRelaySourceV3ResResponseMetadata
- type UpdateRelaySourceV3ResResponseMetadataError
- type UpdateSnapshotPreset
- type UpdateSnapshotPresetBody
- type UpdateSnapshotPresetBodyCallbackDetailListItem
- type UpdateSnapshotPresetQuery
- type UpdateSnapshotPresetReq
- type UpdateSnapshotPresetRes
- type UpdateSnapshotPresetResResponseMetadata
- type UpdateSnapshotPresetResResponseMetadataError
- type UpdateSubtitleTranscodePreset
- type UpdateSubtitleTranscodePresetBody
- type UpdateSubtitleTranscodePresetBodyPosition
- type UpdateSubtitleTranscodePresetBodySourceLanguage
- type UpdateSubtitleTranscodePresetBodySourceLanguageBorder
- type UpdateSubtitleTranscodePresetBodyTargetLanguageItem
- type UpdateSubtitleTranscodePresetBodyTargetLanguageItemBorder
- type UpdateSubtitleTranscodePresetQuery
- type UpdateSubtitleTranscodePresetReq
- type UpdateSubtitleTranscodePresetRes
- type UpdateSubtitleTranscodePresetResResponseMetadata
- type UpdateTimeShiftPresetV2
- type UpdateTimeShiftPresetV2Body
- type UpdateTimeShiftPresetV2Query
- type UpdateTimeShiftPresetV2Req
- type UpdateTimeShiftPresetV2Res
- type UpdateTimeShiftPresetV2ResResponseMetadata
- type UpdateTimeShiftPresetV2ResResponseMetadataError
- type UpdateTranscodePreset
- type UpdateTranscodePresetBody
- type UpdateTranscodePresetBodyTranscodeStruct
- type UpdateTranscodePresetQuery
- type UpdateTranscodePresetReq
- type UpdateTranscodePresetRes
- type UpdateTranscodePresetResResponseMetadata
- type UpdateTranscodePresetResResponseMetadataError
- type UpdateUserAgentAccessRule
- type UpdateUserAgentAccessRuleBody
- type UpdateUserAgentAccessRuleBodyUaAccessRule
- type UpdateUserAgentAccessRuleQuery
- type UpdateUserAgentAccessRuleReq
- type UpdateUserAgentAccessRuleRes
- type UpdateUserAgentAccessRuleResResponseMetadata
- type UpdateWatermarkPreset
- type UpdateWatermarkPresetBody
- type UpdateWatermarkPresetQuery
- type UpdateWatermarkPresetReq
- type UpdateWatermarkPresetRes
- type UpdateWatermarkPresetResResponseMetadata
- type UpdateWatermarkPresetResResponseMetadataError
Constants ¶
const ( ServiceName = "live" DefaultTimeout = 10 * time.Second )
Variables ¶
var ( ServiceInfoMap = map[string]common.ServiceInfo{ "cn-north-1": { Timeout: DefaultTimeout, Scheme: "https", Host: "open.byteplusapi.com", Header: http.Header{ "Accept": []string{"application/json"}, }, Credentials: common.Credentials{ Region: "cn-north-1", Service: ServiceName, }, }, } ApiListInfo = map[string]*common.ApiInfo{}/* 145 elements not displayed */ )
Functions ¶
This section is empty.
Types ¶
type BindCertBody ¶
type BindCertBody struct {
// REQUIRED; 需要绑定的 HTTPS 证书的证书链 ID,可以通过查询证书列表 [https://www.volcengine.com/docs/6469/1126822]接口获取。
ChainID string `json:"ChainID"`
// REQUIRED; 填写需要配置 HTTPS 证书的域名。 您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要绑定证书的域名。
Domain string `json:"Domain"`
// 证书域名。
CertDomain *string `json:"CertDomain,omitempty"`
// 是否启用 HTTPS 协议,默认值为 false,取值及含义如下所示。
// * false:关闭;
// * true:启用。
HTTPS *bool `json:"HTTPS,omitempty"`
// 最大支持的TLS版本,不填默认不校验,可选值为:TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3
MaxTLSVersion *string `json:"MaxTLSVersion,omitempty"`
// 最小支持的TLS版本,不填默认为TLSv1.2,可选值为:TLSv1.0、TLSv1.1、TLSv1.2、TLSv1.3
MinTLSVersion *string `json:"MinTLSVersion,omitempty"`
// 是否是客户自定义的证书链,如果是则跳过证书合法性校验。不填默认为false。
UserDefinedChain *bool `json:"UserDefinedChain,omitempty"`
// 视频直播服务的配置空间,由 1 到 60 位数字、字母、下划线及"-"和"."组成 :::tip 与 Domain 二选一。
Vhost *string `json:"Vhost,omitempty"`
}
type BindCertQuery ¶
type BindCertQuery struct{}
type BindCertReq ¶
type BindCertReq struct {
*BindCertQuery
*BindCertBody
}
type BindCertRes ¶
type BindCertRes struct {
// REQUIRED
ResponseMetadata BindCertResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type BindCertResResponseMetadata ¶
type BindCertResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *BindCertResResponseMetadataError `json:"Error,omitempty"`
}
type BindEncryptDRM ¶
type BindEncryptDRM struct{}
type BindEncryptDRMBody ¶
type BindEncryptDRMBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 加密类型,支持的取值及含义如下所示。
// * FairPlay:使用 FairPlay 技术的商业 DRM 加密;
// * Widevine:使用 Widevine 技术的商业 DRM 加密;
// * PlayReady:使用 PlayReady 技术的商业 DRM 加密;
// * ClearKey:HLS 标准加密。
// :::tip DRM 加密与 HLS 标准加密不可同时配置。 :::
DRMSystems []string `json:"DRMSystems"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 是否开启当前 DRM 加密配置,取值及含义如下所示。
// * true:(默认值)开启;
// * false:关闭。
Enable *bool `json:"Enable,omitempty"`
// 是否开启源流加密,取值及含义如下所示。
// * true:开启;
// * fasle:不开启。
EncryptOriginStream *bool `json:"EncryptOriginStream,omitempty"`
// 是否开启转码流加密,取值及含义如下所示。
// * true:开启;
// * fasle:不开启。
EncryptTranscodeStream *bool `json:"EncryptTranscodeStream,omitempty"`
// 开启转码流加密时待加密的转码流对应的转码流后缀配置。您可以调用查询转码配置列表 [https://www.volcengine.com/docs/6469/1126853]接口或在视频直播控制台的转码配置 [https://console.volcengine.com/live/main/application/transcode]页面,查看转码配置的转码流后缀。
EncryptTranscodeSuffix []*string `json:"EncryptTranscodeSuffix,omitempty"`
}
type BindEncryptDRMQuery ¶
type BindEncryptDRMQuery struct{}
type BindEncryptDRMReq ¶
type BindEncryptDRMReq struct {
*BindEncryptDRMQuery
*BindEncryptDRMBody
}
type BindEncryptDRMRes ¶
type BindEncryptDRMRes struct {
// REQUIRED
ResponseMetadata BindEncryptDRMResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED; Anything
Result interface{} `json:"Result"`
}
type BindEncryptDRMResResponseMetadata ¶
type BindEncryptDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type Components1404CjzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesTosparam ¶
type Components1404CjzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesTosparam struct {
Bucket string `json:"Bucket"`
Enable bool `json:"Enable"`
ExactObject string `json:"ExactObject"`
StorageDir string `json:"StorageDir"`
}
Components1404CjzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesTosparam - TOS 存储相关配置 说明 TOSParam和VODParam配置且配置其中一个。
type Components1523StvSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguage ¶ added in v1.0.32
type Components1523StvSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguage struct {
Border Components1O8E0AlSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguagePropertiesBorder `json:"Border"`
Display bool `json:"Display"`
Font string `json:"Font"`
FontColor string `json:"FontColor"`
FontSize int32 `json:"FontSize"`
Language string `json:"Language"`
}
Components1523StvSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguage - 原文字幕展示参数配置。
type Components17Ohct5SchemasDescribeliveasrdurationdataresPropertiesResultPropertiesAsrdurationdetaildataItemsPropertiesAsrdurationdataItems ¶ added in v1.0.28
type Components1C398ShSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesTargetlanguageItems ¶ added in v1.0.32
type Components1C398ShSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesTargetlanguageItems struct {
Border ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePresetTargetLanguageItemBorder `json:"Border"`
Font string `json:"Font"`
FontColor string `json:"FontColor"`
FontSize int32 `json:"FontSize"`
Language string `json:"Language"`
}
type Components1Hkcrc4SchemasListvhostsnapshotpresetresPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetPropertiesCallbackdetail ¶ added in v1.0.28
type Components1Hkcrc4SchemasListvhostsnapshotpresetresPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetPropertiesCallbackdetail struct {
URL string `json:"URL"`
CallbackType *string `json:"CallbackType,omitempty"`
}
Components1Hkcrc4SchemasListvhostsnapshotpresetresPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetPropertiesCallbackdetail - 回调信息。
type Components1Nf1A8CSchemasListpulltopushtaskv2ResPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems ¶ added in v1.0.32
type Components1O8E0AlSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguagePropertiesBorder ¶ added in v1.0.32
type Components1O8E0AlSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguagePropertiesBorder struct {
Color string `json:"Color"`
Width int32 `json:"Width"`
}
Components1O8E0AlSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguagePropertiesBorder - 原文字幕的字体描边配置。
type Components1Via6UrSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesTosparam ¶
type Components1Via6UrSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesTosparam struct {
Bucket string `json:"Bucket"`
Enable bool `json:"Enable"`
ExactObject string `json:"ExactObject"`
StorageDir string `json:"StorageDir"`
}
Components1Via6UrSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesTosparam - TOS 存储相关配置 说明 TOSParam和VODParam配置且配置其中一个。
type Components1Wv3ClqSchemasUpdatetranscodepresetbodyPropertiesTranscodestructPropertiesAbtestAdditionalproperties ¶
type Components44Na0KSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparam ¶
type Components44Na0KSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparam struct {
Duration *int32 `json:"Duration,omitempty"`
Enable *bool `json:"Enable,omitempty"`
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
Splice *int32 `json:"Splice,omitempty"`
TOSParam *ComponentsBbqv7RSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesTosparam `json:"TOSParam,omitempty"`
VODParam *ComponentsKovkk9SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesVodparam `json:"VODParam,omitempty"`
}
Components44Na0KSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparam - 录制为 FLV 格式时的录制参数。
type ComponentsAoysk3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparam ¶
type ComponentsAoysk3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparam struct {
Duration *int32 `json:"Duration,omitempty"`
Enable *bool `json:"Enable,omitempty"`
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
Splice *int32 `json:"Splice,omitempty"`
TOSParam *Components1404CjzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesTosparam `json:"TOSParam,omitempty"`
VODParam *ComponentsS0Ofr3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesVodparam `json:"VODParam,omitempty"`
}
ComponentsAoysk3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparam - 录制为 HLS 格式时的录制参数。
type ComponentsBbqv7RSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesTosparam ¶
type ComponentsBbqv7RSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesTosparam struct {
Bucket string `json:"Bucket"`
Enable bool `json:"Enable"`
ExactObject string `json:"ExactObject"`
StorageDir string `json:"StorageDir"`
}
ComponentsBbqv7RSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesTosparam - TOS 存储相关配置。
type ComponentsFuamuzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfig ¶
type ComponentsFuamuzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfig struct {
FlvParam *Components44Na0KSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparam `json:"FlvParam,omitempty"`
HlsParam *ComponentsAoysk3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparam `json:"HlsParam,omitempty"`
Mp4Param *ComponentsKqy98ZSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4Param `json:"Mp4Param,omitempty"`
OriginRecord *int32 `json:"OriginRecord,omitempty"`
SliceDuration *int32 `json:"SliceDuration,omitempty"`
TranscodeRecord *int32 `json:"TranscodeRecord,omitempty"`
TranscodeSuffixList []*string `json:"TranscodeSuffixList,omitempty"`
}
ComponentsFuamuzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfig - 录制模板详细配置。
type ComponentsGg7M1TSchemasListpulltopushtaskresPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems ¶ added in v1.0.32
type ComponentsJ1MbxoSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesPosition ¶ added in v1.0.32
type ComponentsJ1MbxoSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesPosition struct {
MarginHorizontal float32 `json:"MarginHorizontal"`
MarginVertical float32 `json:"MarginVertical"`
Relative string `json:"Relative"`
}
ComponentsJ1MbxoSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesPosition - 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。 :::tip * 使用预设配置时,字幕位置设置不生效。 * 不使用预设配置时,字幕位置设置必填。 :::
type ComponentsKovkk9SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesVodparam ¶
type ComponentsKovkk9SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesVodparam struct {
ClassificationID *int32 `json:"ClassificationID,omitempty"`
Enable *bool `json:"Enable,omitempty"`
ExactObject *string `json:"ExactObject,omitempty"`
StorageClass *int32 `json:"StorageClass,omitempty"`
VodNamespace *string `json:"VodNamespace,omitempty"`
WorkflowID *string `json:"WorkflowID,omitempty"`
}
ComponentsKovkk9SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesFlvparamPropertiesVodparam - VOD 存储相关配置。
type ComponentsKqy98ZSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4Param ¶
type ComponentsKqy98ZSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4Param struct {
Duration *int32 `json:"Duration,omitempty"`
Enable *bool `json:"Enable,omitempty"`
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
Splice *int32 `json:"Splice,omitempty"`
TOSParam *Components1Via6UrSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesTosparam `json:"TOSParam,omitempty"`
VODParam *ComponentsQms0JiSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesVodparam `json:"VODParam,omitempty"`
}
ComponentsKqy98ZSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4Param - 录制为 HLS 格式时的录制参数。
type ComponentsQms0JiSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesVodparam ¶
type ComponentsQms0JiSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesVodparam struct {
ClassificationID *int32 `json:"ClassificationID,omitempty"`
Enable *bool `json:"Enable,omitempty"`
ExactObject *string `json:"ExactObject,omitempty"`
StorageClass *int32 `json:"StorageClass,omitempty"`
VodNamespace *string `json:"VodNamespace,omitempty"`
WorkflowID *string `json:"WorkflowID,omitempty"`
}
ComponentsQms0JiSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesMp4ParamPropertiesVodparam - VOD 存储相关配置 说明 TOSParam和VODParam配置且配置其中一个。
type ComponentsS0Ofr3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesVodparam ¶
type ComponentsS0Ofr3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesVodparam struct {
ClassificationID *int32 `json:"ClassificationID,omitempty"`
Enable *bool `json:"Enable,omitempty"`
ExactObject *string `json:"ExactObject,omitempty"`
StorageClass *int32 `json:"StorageClass,omitempty"`
VodNamespace *string `json:"VodNamespace,omitempty"`
WorkflowID *string `json:"WorkflowID,omitempty"`
}
ComponentsS0Ofr3SchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfigPropertiesHlsparamPropertiesVodparam - VOD 存储相关配置 说明 TOSParam和VODParam配置且配置其中一个。
type CreateCert ¶
type CreateCert struct{}
type CreateCertBody ¶
type CreateCertBody struct {
// REQUIRED; 证书信息。
Rsa CreateCertBodyRsa `json:"Rsa"`
// REQUIRED; 证书用途,默认为 https,取值及含义如下所示。
// * https:用于 HTTPS 加密;
// * sign:用于签名加密。
UseWay string `json:"UseWay"`
// 证书名称。
CertName *string `json:"CertName,omitempty"`
// 证书链 ID,用于标识整个证书链,包括叶子证书(服务器证书)、中间证书(中间 CA 证书)以及根证书(根 CA 证书)。
ChainID *string `json:"ChainID,omitempty"`
// 项目名称,默认值为 default,您可以登录访问控制 [https://console.volcengine.com/iam/resourcemanage/project]获取项目名称。
ProjectName *string `json:"ProjectName,omitempty"`
}
type CreateCertBodyRsa ¶
type CreateCertBodyRsa struct {
// REQUIRED; 证书私钥。
Prikey string `json:"Prikey"`
// REQUIRED; 证书公钥。
Pubkey string `json:"Pubkey"`
}
CreateCertBodyRsa - 证书信息。
type CreateCertQuery ¶
type CreateCertQuery struct{}
type CreateCertReq ¶
type CreateCertReq struct {
*CreateCertQuery
*CreateCertBody
}
type CreateCertRes ¶
type CreateCertRes struct {
// REQUIRED
ResponseMetadata CreateCertResResponseMetadata `json:"ResponseMetadata"`
Result *CreateCertResResult `json:"Result,omitempty"`
}
type CreateCertResResponseMetadata ¶
type CreateCertResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreateCertResResponseMetadataError `json:"Error,omitempty"`
}
type CreateCertResResult ¶
type CreateCloudMixTask ¶ added in v1.0.32
type CreateCloudMixTask struct{}
type CreateCloudMixTaskBody ¶ added in v1.0.32
type CreateCloudMixTaskBody struct {
// REQUIRED; 混流任务详细配置。
MixedRules CreateCloudMixTaskBodyMixedRules `json:"MixedRules"`
// REQUIRED; 混流任务名称,与正在进行中的任务名称不能重复。
Name string `json:"Name"`
}
type CreateCloudMixTaskBodyMixedRules ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRules struct {
// REQUIRED; 混流输出布局配置。
InputLayout CreateCloudMixTaskBodyMixedRulesInputLayout `json:"InputLayout"`
// REQUIRED; 混流素材列表,最多支持配置 8 路素材。
InputSource []CreateCloudMixTaskBodyMixedRulesInputSourceItem `json:"InputSource"`
// REQUIRED; 混流输出视频质量参数配置。
Output CreateCloudMixTaskBodyMixedRulesOutput `json:"Output"`
}
CreateCloudMixTaskBodyMixedRules - 混流任务详细配置。
type CreateCloudMixTaskBodyMixedRulesInputLayout ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputLayout struct {
// REQUIRED; 混流输出画布配置及素材布局配置。
Scene CreateCloudMixTaskBodyMixedRulesInputLayoutScene `json:"Scene"`
// 混流输出视频中 Logo 布局配置。
// :::tip 支持最多配置 4 个 Logo,展示层级以添加顺序为准。 :::
Logo []*CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItem `json:"Logo,omitempty"`
// 预设混流模板 ID。 模板配置还有变动,后续稳定后对外,且后续支持用户自定义模板。
TemplateID *string `json:"TemplateID,omitempty"`
}
CreateCloudMixTaskBodyMixedRulesInputLayout - 混流输出布局配置。
type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItem ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItem struct {
// REQUIRED; Logo 图片在混流输出整体画面中的布局配置。
Layout CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout `json:"Layout"`
// REQUIRED; Logo 图片访问地址。
URL string `json:"Url"`
}
type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout struct {
// REQUIRED
H int32 `json:"H"`
// REQUIRED
W int32 `json:"W"`
// REQUIRED
X int32 `json:"X"`
// REQUIRED
Y int32 `json:"Y"`
}
CreateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout - Logo 图片在混流输出整体画面中的布局配置。
type CreateCloudMixTaskBodyMixedRulesInputLayoutScene ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputLayoutScene struct {
// REQUIRED; 混流输出整体画布高度,单位为 px,取值范围为 [10,2160]。
Height int32 `json:"Height"`
// REQUIRED; 混流素材在混流输出整体画面中的布局配置。 :::tip 混流素材布局中需包含所有素材的配置,且需与通过 Layer 参数与混流素材一一匹配。 :::
Layout []CreateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem `json:"Layout"`
// REQUIRED; 混流输出画布整体宽度,单位为 px,取值范围为 [10,2160]。
Width int32 `json:"Width"`
}
CreateCloudMixTaskBodyMixedRulesInputLayoutScene - 混流输出画布配置及素材布局配置。
type CreateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem struct {
// REQUIRED; 当前素材或 Logo 图片在混流输出画面中的限制高度,单位为 px,取值范围为 [10,2160]。
// :::tip 限制宽度和限制高度指定了素材展示的限制范围,当素材尺寸和限制值不一致时,素材将在限制范围内根据长边进行等比缩放,其余区域透明展示。 :::
H int32 `json:"H"`
// REQUIRED; 当配置素材布局时需要通过 Layer 参数与素材进行一一对应。 :::tip 配置 Logo 图片的布局时此参数不生效。 :::
Layer int32 `json:"Layer"`
// REQUIRED; 当前素材或 Logo 图片在混流输出画面中的限制宽度,单位为 px,取值范围为 [10,2160]。
W int32 `json:"W"`
// REQUIRED; 当前素材或 Logo 图片在输出画面中相对画面左上角的 X 偏移位置,单位为 px,取值范围为 0 到设置的画面宽度。
X int32 `json:"X"`
// REQUIRED; 当前素材或 Logo 图片在输出画面中相对画面左上角的 Y 偏移位置,单位为 px,取值范围为 0 到设置的画面高度。
Y int32 `json:"Y"`
}
type CreateCloudMixTaskBodyMixedRulesInputSourceItem ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesInputSourceItem struct {
// REQUIRED; 混流素材 ID,一个任务中素材 ID 不能重复,此 ID 用于任务状态回调消息中标识素材。
ID string `json:"ID"`
// REQUIRED; 混流素材的叠放顺序,1 为最底层,2 层在 1 层之上,以此类推,取值范围为[1,9999]。 :::tip 当前准备使用某个素材作为布局背景时,其叠放顺序应设置为所有素材中的最小值。 :::
Layer int32 `json:"Layer"`
// REQUIRED; 混流素材类型,支持的取值及含义如下所示。
// * vod:视频点播中的素材,支持 MP4、FLV 格式素材;
// * live:直播源素材,支持 RTMP、FLV 协议拉流地址;
// * pic:图片素材,支持 png、jpg 格式图片。
Type string `json:"Type"`
// REQUIRED; 混流素材的访问地址。 :::tip 混流素材的访问地址需与混流素材的类型保持对应关系。 :::
URL string `json:"Url"`
}
type CreateCloudMixTaskBodyMixedRulesOutput ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesOutput struct {
// REQUIRED; 混流音频参数设置。
Audio CreateCloudMixTaskBodyMixedRulesOutputAudio `json:"Audio"`
// REQUIRED; 混流视频的推流地址,支持最多配置 8 个推流地址。
URL []string `json:"Url"`
// REQUIRED; 混流视频参数设置。
Video CreateCloudMixTaskBodyMixedRulesOutputVideo `json:"Video"`
// 任务状态回调地址配置。
Callback *CreateCloudMixTaskBodyMixedRulesOutputCallback `json:"Callback,omitempty"`
}
CreateCloudMixTaskBodyMixedRulesOutput - 混流输出视频质量参数配置。
type CreateCloudMixTaskBodyMixedRulesOutputAudio ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesOutputAudio struct {
// REQUIRED; 混流输出流的音频码率,单位为 bps,取值范围为 [128000,320000],常见取值及含义如下所示。
// * 128000:128 kbps;
// * 144000:144 kbps;
// * 256000:256 kbps;
// * 320000:320 kbps。
BitRate int32 `json:"BitRate"`
// REQUIRED; 混流输出流的音频声道设置,取值及含义如下所示。
// * mono:单声道;
// * stereo:立体声。
ChannelLayout string `json:"ChannelLayout"`
// REQUIRED; 混流输出流的音频采样率,单位为 HZ,常见取值及含义如下所示。
// * 32000:32 kHZ;
// * 44100:44.1 kHZ;
// * 48000:48 kHZ。
SampleRate int32 `json:"SampleRate"`
}
CreateCloudMixTaskBodyMixedRulesOutputAudio - 混流音频参数设置。
type CreateCloudMixTaskBodyMixedRulesOutputCallback ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesOutputCallback struct {
// REQUIRED; 接收云端混流任务状态回调的 HTTP 地址。
URL string `json:"Url"`
}
CreateCloudMixTaskBodyMixedRulesOutputCallback - 任务状态回调地址配置。
type CreateCloudMixTaskBodyMixedRulesOutputVideo ¶ added in v1.0.32
type CreateCloudMixTaskBodyMixedRulesOutputVideo struct {
// REQUIRED; 混流输出视频码率,单位为 bps,取值范围为 [1000000,20000000],输入值小于或大于取值范围时会进行自动修正至最小值和最大值。
BitRate int32 `json:"BitRate"`
// REQUIRED; 混流输出视频编码格式,支持的取值及含义如下所示。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式。
Codec string `json:"Codec"`
// REQUIRED; 混流输出视频帧率,单位为 fps,取值范围为 [10,60],输入值小于或大于取值范围时会进行自动修正至最小值和最大值。
FrameRate int32 `json:"FrameRate"`
// REQUIRED; IDR 帧之间的最大间隔时间,单位为秒,取值范围为 [1,10]。
GOP int32 `json:"GOP"`
}
CreateCloudMixTaskBodyMixedRulesOutputVideo - 混流视频参数设置。
type CreateCloudMixTaskQuery ¶ added in v1.0.32
type CreateCloudMixTaskQuery struct{}
type CreateCloudMixTaskReq ¶ added in v1.0.32
type CreateCloudMixTaskReq struct {
*CreateCloudMixTaskQuery
*CreateCloudMixTaskBody
}
type CreateCloudMixTaskRes ¶ added in v1.0.32
type CreateCloudMixTaskRes struct {
// REQUIRED
ResponseMetadata CreateCloudMixTaskResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *CreateCloudMixTaskResResult `json:"Result,omitempty"`
}
type CreateCloudMixTaskResResponseMetadata ¶ added in v1.0.32
type CreateCloudMixTaskResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type CreateCloudMixTaskResResult ¶ added in v1.0.32
type CreateCloudMixTaskResResult struct {
// REQUIRED; 请求响应码,取值及含义如下。
// * 0:请求成功;
// * 500:内部处理错误;
// * 400:请求异常。
Code int32 `json:"Code"`
// REQUIRED; 返回的数据。
Data CreateCloudMixTaskResResultData `json:"Data"`
// REQUIRED; 请求响应码对应的信息。
Message string `json:"Message"`
}
CreateCloudMixTaskResResult - 视请求的接口而定
type CreateCloudMixTaskResResultData ¶ added in v1.0.32
type CreateCloudMixTaskResResultData struct {
// REQUIRED; 混流任务 ID。
TaskID string `json:"TaskID"`
}
CreateCloudMixTaskResResultData - 返回的数据。
type CreateDomainV2 ¶
type CreateDomainV2 struct{}
type CreateDomainV2Body ¶
type CreateDomainV2Body struct {
// REQUIRED; 待添加到视频直播服务进行加速的域名列表信息。 :::tip 一个域名空间下最多包含 10 个域名。 :::
Domains []CreateDomainV2BodyDomainsItem `json:"Domains"`
// REQUIRED; 域名空间,是一组关联域名的集合,由字母(A - Z、a -z)、数字(0 - 9)和连字符(-) 组成。您可以自定义新的域名空间或调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口获取已有域名使用的域名空间。
Vhost string `json:"Vhost"`
// 为域名空间设置所属项目,默认为空表示归属到 default 项目, 新建域名空间时需要为域名空间绑定项目,您可以在访问控制-项目列表 [https://console.volcengine.com/iam/resourcemanage/project]查看已有项目并对项目进行管理。
// 项目是火山引擎提供的一种资源管理方式,您可以对不同业务或项目使用的云资源进行分组管理,以实现基于项目的账单查看、子账号授权等功能。
// * 新建域名空间时,需为域名空间设置所属项目。每个域名空间只能属于一个项目,选择已有的域名空间时,项目不可配置;
// * 使用基于项目的账单查看需提前开通分账服务,请前往账单管理-分账账单 [https://console.volcengine.com/finance/bill/split-bill/]进行服务开通;
// * 使用基于项目的子账号授权请参见使用 IAM 用户进行项目权限划分 [https://www.volcengine.com/docs/6469/1166573]。
ProjectName *string `json:"ProjectName,omitempty"`
// 为域名空间设置资源标签。您可以通过资源标签从不同维度对云资源进行分类和聚合管理,如资源分账等场景。 :::tip 如需使用标签进行资源分账,可以在可以在账单管理-费用标签 [https://console.volcengine.com/finance/bill/tag/]处管理启用标签,将对应标签运用到账单明细等数据中。
// :::
Tags []*CreateDomainV2BodyTagsItem `json:"Tags,omitempty"`
}
type CreateDomainV2BodyDomainsItem ¶
type CreateDomainV2BodyDomainsItem struct {
// REQUIRED; 域名名称,域名由字母(A - Z、a -z)、数字(0 - 9)和连字符(-) 组成,长度为 1 到 60 个字符。
DomainName string `json:"DomainName"`
// REQUIRED; 国内可传入:
// * cn 国内
// * cn-oversea 海外及港澳台
// * cn-global 全球 byteplus可传入:
// * cn 中国
// * oversea 非中国区
// * global 全球
Region string `json:"Region"`
// REQUIRED; 域名类型,取值及含义如下所示。
// * push:推流域名;
// * pull-flv:拉流域名。
Type string `json:"Type"`
// HTTPS 证书链 ID,默认为空表示不为域名绑定 HTTPS 证书。您可以调用 ListCertV2 [https://www.volcengine.com/docs/6469/1126823] 接口或在视频直播控制台的证书管理 [https://console.volcengine.com/live/main/certificate]页面,获取待绑定的证书链
// ID。
ChainID *string `json:"ChainID,omitempty"`
}
type CreateDomainV2Query ¶
type CreateDomainV2Query struct{}
type CreateDomainV2Req ¶
type CreateDomainV2Req struct {
*CreateDomainV2Query
*CreateDomainV2Body
}
type CreateDomainV2Res ¶
type CreateDomainV2Res struct {
// REQUIRED
ResponseMetadata CreateDomainV2ResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type CreateDomainV2ResResponseMetadata ¶
type CreateDomainV2ResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *CreateDomainV2ResResponseMetadataError `json:"Error,omitempty"`
}
type CreateLiveVideoQualityAnalysisTask ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTask struct{}
type CreateLiveVideoQualityAnalysisTaskBody ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskBody struct {
// REQUIRED; 源流地址,支持flv、hls、rtmp地址
SrcURL string `json:"SrcURL"`
// 任务运行时常,支持60-300,单位s,默认180
Duration *int32 `json:"Duration,omitempty"`
// 截图间隔,支持3-10s,单位s,不填默认为10s
Interval *int32 `json:"Interval,omitempty"`
// 任务名称,用来查询使用。
Name *string `json:"Name,omitempty"`
}
type CreateLiveVideoQualityAnalysisTaskQuery ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskQuery struct{}
type CreateLiveVideoQualityAnalysisTaskReq ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskReq struct {
*CreateLiveVideoQualityAnalysisTaskQuery
*CreateLiveVideoQualityAnalysisTaskBody
}
type CreateLiveVideoQualityAnalysisTaskRes ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskRes struct {
// REQUIRED
ResponseMetadata CreateLiveVideoQualityAnalysisTaskResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *CreateLiveVideoQualityAnalysisTaskResResult `json:"Result,omitempty"`
}
type CreateLiveVideoQualityAnalysisTaskResResponseMetadata ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type CreateLiveVideoQualityAnalysisTaskResResult ¶ added in v1.0.32
type CreateLiveVideoQualityAnalysisTaskResResult struct {
// REQUIRED; 任务ID
ID string `json:"ID"`
// REQUIRED; 任务名称
Name string `json:"Name"`
}
CreateLiveVideoQualityAnalysisTaskResResult - 视请求的接口而定
type CreatePullToPushGroup ¶ added in v1.0.32
type CreatePullToPushGroup struct{}
type CreatePullToPushGroupBody ¶ added in v1.0.32
type CreatePullToPushGroupBody struct {
// REQUIRED; 群组名称,支持有中文、大小写字母和数字组成,最大长度为 20 个字符。
Name string `json:"Name"`
// REQUIRED; 为任务群组设置所属项目,您可以在访问控制-项目列表 [https://console.volcengine.com/iam/resourcemanage/project]查看已有项目并对项目进行管理。 项目是火山引擎提供的一种资源管理方式,您可以对不同业务或项目使用的云资源进行分组管理,以实现基于项目的账单查看、子账号授权等功能。
ProjectName string `json:"ProjectName"`
// 为任务群组设置资源标签。您可以通过资源标签从不同维度对云资源进行分类和聚合管理,如资源分账等场景。 :::tip 如需使用标签进行资源分账,可以在可以在账单管理-费用标签 [https://console.volcengine.com/finance/bill/tag/]处管理启用标签,将对应标签运用到账单明细等数据中。
// :::
Tags []*CreatePullToPushGroupBodyTagsItem `json:"Tags,omitempty"`
}
type CreatePullToPushGroupBodyTagsItem ¶ added in v1.0.32
type CreatePullToPushGroupQuery ¶ added in v1.0.32
type CreatePullToPushGroupQuery struct{}
type CreatePullToPushGroupReq ¶ added in v1.0.32
type CreatePullToPushGroupReq struct {
*CreatePullToPushGroupQuery
*CreatePullToPushGroupBody
}
type CreatePullToPushGroupRes ¶ added in v1.0.32
type CreatePullToPushGroupRes struct {
// REQUIRED
ResponseMetadata CreatePullToPushGroupResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type CreatePullToPushGroupResResponseMetadata ¶ added in v1.0.32
type CreatePullToPushGroupResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type CreatePullToPushTask ¶
type CreatePullToPushTask struct{}
type CreatePullToPushTaskBody ¶
type CreatePullToPushTaskBody struct {
// REQUIRED; 任务的结束时间,Unix 时间戳,单位为秒。 :::tip 拉流转推任务持续时间最长为 7 天。 :::
EndTime int32 `json:"EndTime"`
// REQUIRED; 任务的开始时间,Unix 时间戳,单位为秒。 :::tip 拉流转推任务持续时间最长为 7 天。 :::
StartTime int32 `json:"StartTime"`
// REQUIRED; 拉流来源类型,支持的取值及含义如下。
// * 0:直播源;
// * 1:点播视频。
Type int32 `json:"Type"`
// 推流应用名称,推流地址(DstAddr)为空时必传;反之,则该参数不生效。
App *string `json:"App,omitempty"`
// 接收拉流转推任务状态回调的地址,最大长度为 512 个字符,默认为空。
CallbackURL *string `json:"CallbackURL,omitempty"`
// 续播策略,续播策略指转推点播视频进行直播时出现断流并恢复后,如何继续播放的策略,拉流来源类型为点播视频(Type 为 1)时参数生效,支持的取值及含义如下。
// * 0:从断流处续播(默认值);
// * 1:从断流处+自然流逝时长处续播。
ContinueStrategy *int32 `json:"ContinueStrategy,omitempty"`
// 点播视频文件循环播放模式,当拉流来源类型为点播视频时为必选参数,参数取值及含义如下所示。
// * -1:无限次循环,至任务结束;
// * 0:有限次循环,循环次数以 PlayTimes 取值为准;
// * >0:有限次循环,循环次数以 CycleMode 取值为准。
CycleMode *int32 `json:"CycleMode,omitempty"`
// 推流域名,推流地址(DstAddr)为空时必传;反之,则该参数不生效。
Domain *string `json:"Domain,omitempty"`
// 推流地址,即直播源或点播视频转推的目标地址。
DstAddr *string `json:"DstAddr,omitempty"`
// 群组所属名称,您可以调用 ListPullToPushGroup [https://www.volcengine.com/docs/6469/1327382] 获取可用的群组。 :::tip
// * 使用主账号调用时,为非必填,默认加入 default 群组,default 群组不存在时会默认创建,并绑定 default 项目。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
// 点播文件启播时间偏移值,单位为秒,仅当点播视频播放地址列表(SrcAddrS)只有一个地址,且未配置 Offsets 时生效,缺省情况下为空表示不进行偏移。 :::tip 此字段为旧版本配置,请使用 VodSrcAddrs 配置点播视频地址和播放偏移时间。
// :::
Offset *float32 `json:"Offset,omitempty"`
// 点播文件启播时间偏移值,单位为秒,数量与拉流地址列表中地址数量相等,缺省情况下为空表示不进行偏移。拉流来源类型为点播视频时,参数生效。 :::tip 此字段为旧版本配置,请使用 VodSrcAddrs 配置点播视频地址和播放偏移时间。 :::
OffsetS []*float32 `json:"OffsetS,omitempty"`
// 点播视频文件循环播放次数,当 CycleMode 取值为 0 时,PlayTimes 取值将作为循环播放次数。 :::tip PlayTimes 为冗余参数,您可以将 PlayTimes 置 0 后直接使用 CycleMode 指定点播视频文件循环播放次数。
// :::
PlayTimes *int32 `json:"PlayTimes,omitempty"`
// 是否开启点播预热,开启点播预热后,系统会自动将点播视频文件缓存到 CDN 节点上,当用户请求直播时,可以直播从 CDN 节点获取视频,从而提高直播流畅度。拉流来源类型为点播视频时,参数生效。
// * 0:不开启;
// * 1:开启(默认值)。
PreDownload *int32 `json:"PreDownload,omitempty"`
// 直播源的拉流地址,拉流来源类型为直播源时,为必传参数,最大长度为 1000 个字符。
SrcAddr *string `json:"SrcAddr,omitempty"`
// 点播视频播放地址列表,拉流来源类型为点播视频时,为必传参数,最多支持传入 30 个点播视频播放地址,每个地址最大长度为 1000 个字符。
// :::tip 此字段为旧版本配置,请使用 VodSrcAddrs 配置点播视频地址和播放偏移时间。 :::
SrcAddrS []*string `json:"SrcAddrS,omitempty"`
// 推流的流名称,推流地址(DstAddr)为空时必传;反之,则该参数不生效。
Stream *string `json:"Stream,omitempty"`
// 拉流转推任务的名称,默认为空表示不配置任务名称。支持由中文、大小写字母(A - Z、a - z)和数字(0 - 9)组成,长度为 1 到 20 各字符。
Title *string `json:"Title,omitempty"`
// 点播文件地址和开始播放、结束播放的时间设置。 :::tip
// * 当 Type 为点播类型时配置生效。
// * 与 SrcAddrS 和 OffsetS 字段不可同时填写。 :::
VodSrcAddrs []*CreatePullToPushTaskBodyVodSrcAddrsItem `json:"VodSrcAddrs,omitempty"`
// 为拉流转推视频添加的水印配置信息。
Watermark *CreatePullToPushTaskBodyWatermark `json:"Watermark,omitempty"`
}
type CreatePullToPushTaskBodyVodSrcAddrsItem ¶ added in v1.0.32
type CreatePullToPushTaskBodyWatermark ¶
type CreatePullToPushTaskBodyWatermark struct {
// REQUIRED; 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/<mediatype>;base64,<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
// 例如,data:image/png;base64,iVBORw0KGg****mCC
Picture string `json:"Picture"`
// REQUIRED; 水印宽度占直播原始画面宽度百分比,支持精度为小数点后两位。
Ratio float32 `json:"Ratio"`
// REQUIRED; 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosX float32 `json:"RelativePosX"`
// REQUIRED; 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosY float32 `json:"RelativePosY"`
}
CreatePullToPushTaskBodyWatermark - 为拉流转推视频添加的水印配置信息。
type CreatePullToPushTaskQuery ¶
type CreatePullToPushTaskQuery struct{}
type CreatePullToPushTaskReq ¶
type CreatePullToPushTaskReq struct {
*CreatePullToPushTaskQuery
*CreatePullToPushTaskBody
}
type CreatePullToPushTaskRes ¶
type CreatePullToPushTaskRes struct {
// REQUIRED
ResponseMetadata CreatePullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
Result *CreatePullToPushTaskResResult `json:"Result,omitempty"`
}
type CreatePullToPushTaskResResponseMetadata ¶
type CreatePullToPushTaskResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreatePullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
}
type CreatePullToPushTaskResResult ¶
type CreatePullToPushTaskResResult struct {
// REQUIRED; 任务 ID,任务的唯一标识。
TaskID string `json:"TaskId"`
}
type CreateRecordPresetV2 ¶
type CreateRecordPresetV2 struct{}
type CreateRecordPresetV2Body ¶
type CreateRecordPresetV2Body struct {
// REQUIRED; 直播流录制配置的详细配置。
RecordPresetConfig CreateRecordPresetV2BodyRecordPresetConfig `json:"RecordPresetConfig"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要录制的直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,取值与直播流地址的 AppName 字段取值相同,由 1 到 30 位数字(0 - 9)、大写小字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,默认为空。 :::tip
// * App 取值为空时,Stream 取值也需为空,表示录制配置为 Vhost 级别的全局配置。
// * App 取值不为空时,Stream 取值含义请参见 Stream 参数说明。 :::
App *string `json:"App,omitempty"`
// 流名称,取值与直播流地址的 StreamName 字段取值相同,支持填写星号(*)或由 1 到 100 位数字(0 - 9)、字母、下划线(_)、短横线(-)和句点(.)组成。
// :::tip
// * App 取值不为空、Stream 取值为空时,表示录制配置为 Vhost + App 级别的配置。
// * App 取值不为空、Stream 取值不为空时,表示录制为 Vhost + App + Stream 的配置。 :::
Stream *string `json:"Stream,omitempty"`
}
type CreateRecordPresetV2BodyRecordPresetConfig ¶
type CreateRecordPresetV2BodyRecordPresetConfig struct {
// 录制为 FLV 格式时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
FlvParam *CreateRecordPresetV2BodyRecordPresetConfigFlvParam `json:"FlvParam,omitempty"`
// 录制为 HLS 合适时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
HlsParam *CreateRecordPresetV2BodyRecordPresetConfigHlsParam `json:"HlsParam,omitempty"`
// 录制为 MP4 格式时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
Mp4Param *CreateRecordPresetV2BodyRecordPresetConfigMp4Param `json:"Mp4Param,omitempty"`
// 是否源流录制,默认值为 0,支持的取值及含义如下所示。
// * 0:不录制;
// * 1:录制。
// :::tip 转码流和源流需至少选一个进行录制,即是否录制转码流(TranscodeRecord)和是否录制源流(OriginRecord)的取值至少一个不为 0。 :::
OriginRecord *int32 `json:"OriginRecord,omitempty"`
// 录制为 HLS 格式时,单个 TS 切片时长,单位为秒,默认值为 10,取值范围为 [5,30]。
SliceDuration *int32 `json:"SliceDuration,omitempty"`
// 是否录制转码流,默认值为 0,支持的取值及含义如下所示。
// * 0:不录制;
// * 1:录制全部转码流;
// * 2:录制指定转码流,即通过转码后缀列表 TranscodeSuffixList匹配转码流进行录制,如果转码流后缀列表为空仍表示录制全部转码流。
// :::tip 转码流和源流需至少选一个进行录制,即是否录制转码流(TranscodeRecord)和是否录制源流(OriginRecord)的取值至少一个不为 0。 :::
TranscodeRecord *int32 `json:"TranscodeRecord,omitempty"`
// 转码流后缀列表,转码流录制配置为根据转码流列表匹配(TranscodeRecord 取值为 2)时生效,TranscodeSuffixList 默认配置为空,效果等同于录制全部转码流。
TranscodeSuffixList []*string `json:"TranscodeSuffixList,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfig - 直播流录制配置的详细配置。
type CreateRecordPresetV2BodyRecordPresetConfigFlvParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigFlvParam struct {
// 实时录制场景下,断流等待时长,单位为秒,默认值为 180,取值范围为 [0,3600]。如果实际断流时间小于断流等待时长,录制任务不会停止;如果实际断流时间大于断流等待时长,录制任务会停止,断流恢复后重新开始一个新的录制任务。
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制场景下,单文件录制时长,单位为秒,默认值为 7200,取值范围为 -1 和 [300,86400]。
// * 取值为 -1 时,表示不限制录制时长,录制结束后生成一个完整的录制文件。
// * 取值为 [300,86400] 之间的值时,表示根据设置的录制文件时长,到达时长立即生成录制文件,完成录制后一起上传。
// :::tip
// * 断流录制场景仅在录制格式为 HLS 时生效,且断流录制和实时录制为二选一配置。
// * 如录制过程中出现断流,对应生成的录制文件时长也会相应缩短。
// :::
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认值为 false,支持的取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制场景下,单文件录制时长,单位为秒,默认值为 1800,取值范围为 [300,21600]。录制时间到达设置的单文件录制时长时,会立即生成录制文件实时上传存储。 :::tip 如录制过程中出现断流,对应生成的录制文件时长也会相应缩短。
// :::
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流录制场景下,断流拼接时长,单位为秒,默认值为 0,支持的取值及含义如下所示。
// * -1:一直拼接,表示每次断流都不会影响录制任务,录制完成后生成一个完整的录制文件;
// * 0:不拼接,表示每次断流结束录制任务生成一个录制文件,断流恢复重新开始一个新的录制任务;
// * 大于 0:拼接容错时间,表示如果断流时间小于拼接容错时间时,则录制任务不会停止,不会生成新的录制文件;如果断流时间大于拼接容错时间,则录制任务停止,断流恢复后重新开始一个新的录制任务。
// :::tip 断流录制场景仅在录制格式为 HLS 时生效,且断流录制和实时录制为二选一配置。 :::
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
TOSParam *CreateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
VODParam *CreateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam `json:"VODParam,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigFlvParam - 录制为 FLV 格式时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam struct {
// TOS 存储对应的 Bucket。例如,存储位置为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 :::tip 如果使用 TOS 存储,即 TOSParam
// 中 Enable 取值为 true 时,Bucket 为必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储规则,最大长度为 200 个字符,支持以record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} 样式设置存储规则,支持输入字母(A - Z、a - z)、数字(0 -
// 9)、短横线(-)、叹号(!)、下划线(_)、句点(.)、星号(*)及占位符。
// 存储规则设置注意事项如下。
// * 目录层级至少包含2级及以上,如live/{App}/{Stream}。
// * record 为自定义字段;
// * {PubDomain} 取值为当前配置的 vhost 值;
// * {App} 取值为当前配置的 AppName 值;
// * {Stream} 取值为当前配置的 StreamName 值;
// * {StartTime} 取值为录制的开始时间戳;
// * {EndTime} 取值为录制的结束时间戳。
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储对应 Bucket 下的存储目录,默认为空。例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。
StorageDir *string `json:"StorageDir,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam - TOS 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息,默认为空。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,支持的取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储规则,最大长度为 200 个字符,支持以record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} 样式设置存储规则,支持输入字母(A - Z、a - z)、数字(0 -
// 9)、短横线(-)、叹号(!)、下划线(_)、句点(.)、星号(*)及占位符。
// 存储规则设置注意事项如下。
// * 目录层级至少包含2级及以上,如live/{App}/{Stream}。
// * record 为自定义字段;
// * {PubDomain} 取值为当前配置的 vhost 值;
// * {App} 取值为当前配置的 AppName 值;
// * {Stream} 取值为当前配置的 StreamName 值;
// * {StartTime} 取值为录制的开始时间戳;
// * {EndTime} 取值为录制的结束时间戳。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型,存储类型介绍请参考媒资存储管理 [https://www.volcengine.com/docs/4/73629#媒资存储]。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询。 :::tip 如果使用 VOD 存储,即 VODParam 中 Enable 取值为 true 时,VodNamespace
// 为必填。 :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 视频点播工作流模板 ID,对于存储在点播的录制文件,会使用该工作流模版对录制的视频进行处理,可登录视频点播控制台 [https://console.volcengine.com/vod/]获取工作流模板 ID,默认为空。
WorkflowID *string `json:"WorkflowID,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam - VOD 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigHlsParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigHlsParam struct {
// 断流等待时长,取值范围[0,3600]
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制单文件录制时长,单位为秒,默认值为 7200,取值范围为 -1,[300,86400],-1 表示一直录制,目前只对 HLS生效.
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制文件时长,单位为 s,取值范围为 [300,21600]
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流拼接间隔时长,对实时录制无效,单位为 s,默认值为 0。支持的取值如下所示。
// * -1:一直拼接;
// * 0:不拼接;
// * 大于 0:断流拼接时间间隔,对 HLS 录制生效。
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
TOSParam *CreateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
VODParam *CreateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam `json:"VODParam,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigHlsParam - 录制为 HLS 合适时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam struct {
// TOS 存储空间,一般使用 CDN 对应的 Bucket :::tip 如果 TOSParam 中的 Enable 取值为 true,则 Bucket 必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置。存储路径为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储目录,默认为空
StorageDir *string `json:"StorageDir,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam - TOS 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置,最大长度为 200 个字符。默认的存储位置为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime},参数格式要求如下所示。
// * 支持删除固定路径,如 {App}/{Stream};
// * 不支持以正斜线(/)或者反斜线(\)开头;
// * 不支持 “//” 和 “/./” 等字符串;
// * 不支持 \b、\t、\n、\v、\f、\r 等字符;
// * 不支持 “..” 作为文件名;
// * 目录层级至少包含 2 级及以上,如live/{App}/{Stream}。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询 :::tip 如果 VODParam 中的 Enable 取值为 true,则 VodNamespace 必填。
// :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 工作流模版 ID,对于存储在点播的录制文件,会使用该工作流模版对视频进行处理。可登录视频点播控制台 [https://console.volcengine.com/vod/]获取 ID
WorkflowID *string `json:"WorkflowID,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam - VOD 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigMp4Param ¶
type CreateRecordPresetV2BodyRecordPresetConfigMp4Param struct {
// 断流等待时长,取值范围[0,3600]
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制单文件录制时长,单位为 s,默认值为 7200,取值范围为 -1,[300,86400],-1表示一直录制,目前只对HLS生效
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制文件时长,单位为 s,取值范围为 [300,21600]
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流拼接间隔时长,对实时录制无效,单位为 s,默认值为 0。支持的取值如下所示。
// * -1:一直拼接;
// * 0:不拼接;
// * 大于 0:断流拼接时间间隔,对 HLS 录制生效。
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
TOSParam *CreateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
VODParam *CreateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam `json:"VODParam,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigMp4Param - 录制为 MP4 格式时的录制参数。 :::tip 您需至少配置一种录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam struct {
// TOS 存储空间,一般使用 CDN 对应的 Bucket :::tip 如果 TOSParam 中的 Enable 取值为 true,则 Bucket 必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置。存储路径为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储目录,默认为空
StorageDir *string `json:"StorageDir,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam - TOS 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam ¶
type CreateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置,最大长度为 200 个字符。默认的存储位置为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime},参数格式要求如下所示。
// * 支持删除固定路径,如 {App}/{Stream};
// * 不支持以正斜线(/)或者反斜线(\)开头;
// * 不支持 “//” 和 “/./” 等字符串;
// * 不支持 \b、\t、\n、\v、\f、\r 等字符;
// * 不支持 “..” 作为文件名;
// * 目录层级至少包含 2 级及以上,如live/{App}/{Stream}。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询 :::tip 如果 VODParam 中的 Enable 取值为 true,则 VodNamespace 必填。
// :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 工作流模版 ID,对于存储在点播的录制文件,会使用该工作流模版对视频进行处理。可登录视频点播控制台 [https://console.volcengine.com/vod/]获取 ID
WorkflowID *string `json:"WorkflowID,omitempty"`
}
CreateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam - VOD 存储相关配置 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type CreateRecordPresetV2Query ¶
type CreateRecordPresetV2Query struct{}
type CreateRecordPresetV2Req ¶
type CreateRecordPresetV2Req struct {
*CreateRecordPresetV2Query
*CreateRecordPresetV2Body
}
type CreateRecordPresetV2Res ¶
type CreateRecordPresetV2Res struct {
// REQUIRED
ResponseMetadata CreateRecordPresetV2ResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type CreateRecordPresetV2ResResponseMetadata ¶
type CreateRecordPresetV2ResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *CreateRecordPresetV2ResResponseMetadataError `json:"Error,omitempty"`
}
type CreateSnapshotPreset ¶
type CreateSnapshotPreset struct{}
type CreateSnapshotPresetBody ¶
type CreateSnapshotPresetBody struct {
// REQUIRED; 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
App string `json:"App"`
// REQUIRED; 截图间隔时间,单位为 s,默认值为 10,取值范围为正整数。
Interval int32 `json:"Interval"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
// ToS 存储的 Bucket。 :::tipBucket 与 ServiceID 传且仅传一个。 :::
Bucket *string `json:"Bucket,omitempty"`
// 回调详情。
CallbackDetailList []*CreateSnapshotPresetBodyCallbackDetailListItem `json:"CallbackDetailList,omitempty"`
// 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。
OverwriteObject *string `json:"OverwriteObject,omitempty"`
// veImageX 的服务 ID。 :::tipBucket 与 ServiceID 传且仅传一个。 :::
ServiceID *string `json:"ServiceID,omitempty"`
// 截图格式。默认值为 jpeg,支持如下取值。
// * jpeg
// * jpg
SnapshotFormat *string `json:"SnapshotFormat,omitempty"`
// 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。
SnapshotObject *string `json:"SnapshotObject,omitempty"`
// 截图模版状态状态。默认开启。
// * 1:开启。
// * 0:关闭。
Status *int32 `json:"Status,omitempty"`
// ToS 存储目录,不传为空。
StorageDir *string `json:"StorageDir,omitempty"`
}
type CreateSnapshotPresetQuery ¶
type CreateSnapshotPresetQuery struct{}
type CreateSnapshotPresetReq ¶
type CreateSnapshotPresetReq struct {
*CreateSnapshotPresetQuery
*CreateSnapshotPresetBody
}
type CreateSnapshotPresetRes ¶
type CreateSnapshotPresetRes struct {
// REQUIRED
ResponseMetadata CreateSnapshotPresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type CreateSnapshotPresetResResponseMetadata ¶
type CreateSnapshotPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreateSnapshotPresetResResponseMetadataError `json:"Error,omitempty"`
}
type CreateSubtitleTranscodePreset ¶ added in v1.0.32
type CreateSubtitleTranscodePreset struct{}
type CreateSubtitleTranscodePresetBody ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 源语言参数
SourceLanguage CreateSubtitleTranscodePresetBodySourceLanguage `json:"SourceLanguage"`
// REQUIRED; 关联的转码配置后缀,一个字幕配置支持关联多个转码配置后缀。
Suffixes []string `json:"Suffixes"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 字幕配置的描述信息。
Description *string `json:"Description,omitempty"`
// 预设配置,使用预设配置是系统将自动对字体大小、字幕行数、每行最大字符数和边距参数(MarginVertical 和 MarginHorizontal)进行智能化适配。默认为空,表示不使用预设配置,支持的预设配置如下所示。
// * small :小字幕。
// * medium:中字幕。
// * large:大字幕。 :::tip 使用预设配置时,字幕行数、每行最大字符数、左右边距和底部边距参数不生效,系统将使用预设配置自动进行计算。 :::
DisplayPreset *string `json:"DisplayPreset,omitempty"`
// 原文翻译成译文时使用的热词词库,总长度不超过 10000 个字符,默认为空。
GlossaryWordList []*string `json:"GlossaryWordList,omitempty"`
// 原文字幕识别时使用的热词词库,总长度不超过为 10000 个字符,默认为空。
HotWordList []*string `json:"HotWordList,omitempty"`
// 设置在 16:9 分辨率场景下,每行字幕展示的最大字符数。 :::tip
// * 使用预设配置时,字幕每行最大字符数设置不生效。
// * 不使用预设配置时,字幕每行最大字符数必填。
// * 每个文字、字母、符号或数字均为一个字符。
// * 当屏幕分辨率改变时,屏幕上显示的每行文字数量会相应调整,以适应新的分辨率,确保文字的显示效果和阅读体验。 :::
MaxCharNumber *int32 `json:"MaxCharNumber,omitempty"`
// 字幕展示的行数,同时适用于原文字幕和译文字幕,支持的取值及含义如下所示。
// * 0:(默认值)根据字幕字数自动进行分行展示;
// * 1:每种字幕展示一行;
// * 2:每种字幕展示两行。 :::tip
// * 使用预设配置时,字幕行数为自动分行展示。
// * 超出行内字数限制时表示字幕将超过显示范围,此时字幕内容将被截断。 :::
MaxRowNumber *int32 `json:"MaxRowNumber,omitempty"`
// 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。
// :::tip
// * 使用预设配置时,字幕位置设置不生效。
// * 不使用预设配置时,字幕位置设置必填。 :::
Position *CreateSubtitleTranscodePresetBodyPosition `json:"Position,omitempty"`
// 字幕配置的名称,不可以与其他已有的配置名称重复。默认为空,表示由系统将自动分配配置名称。
PresetName *string `json:"PresetName,omitempty"`
// 译文字幕展示参数配置列表,当前最多支持配置一种译文。
TargetLanguage []*CreateSubtitleTranscodePresetBodyTargetLanguageItem `json:"TargetLanguage,omitempty"`
}
type CreateSubtitleTranscodePresetBodyPosition ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodyPosition struct {
// 左右边距,[0,0.2]
MarginHorizontal *float32 `json:"MarginHorizontal,omitempty"`
// 上下边距
MarginVertical *float32 `json:"MarginVertical,omitempty"`
// MarginVertical是相对顶部或底部,默认底部
Relative *CreateSubtitleTranscodePresetBodyPositionRelative `json:"Relative,omitempty"`
}
CreateSubtitleTranscodePresetBodyPosition - 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。 :::tip * 使用预设配置时,字幕位置设置不生效。 * 不使用预设配置时,字幕位置设置必填。 :::
type CreateSubtitleTranscodePresetBodyPositionRelative ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodyPositionRelative string
type CreateSubtitleTranscodePresetBodySourceLanguage ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodySourceLanguage struct {
// REQUIRED; 是否展示源语言
Display bool `json:"Display"`
// REQUIRED; 字体
Font string `json:"Font"`
// REQUIRED; 字体颜色
FontColor string `json:"FontColor"`
// REQUIRED; 原文字幕的语言,取值及含义如下所示。
// * zh:中英混合;
// * en:英语;
// * ko:韩语;
// * ja:日语。
Language string `json:"Language"`
// 字幕阴影配置
Border *CreateSubtitleTranscodePresetBodySourceLanguageBorder `json:"Border,omitempty"`
}
CreateSubtitleTranscodePresetBodySourceLanguage - 源语言参数
type CreateSubtitleTranscodePresetBodySourceLanguageBorder ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodySourceLanguageBorder struct {
// REQUIRED; 阴影颜色
Color string `json:"Color"`
// 填0的时候后端根据字体大小进行计算,字体大小/32*1.25
Width *int32 `json:"Width,omitempty"`
}
CreateSubtitleTranscodePresetBodySourceLanguageBorder - 字幕阴影配置
type CreateSubtitleTranscodePresetBodyTargetLanguageItem ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodyTargetLanguageItem struct {
// REQUIRED; 字体,覆盖全局参数
Font string `json:"Font"`
// REQUIRED; 字体颜色,覆盖全局参数
FontColor string `json:"FontColor"`
// REQUIRED; 译文字幕的语言,取值及含义如下所示。
// * zh:中英混合;
// * zh-Hant:繁体中文;
// * en:英语;
// * ko:韩语;
// * ja:日语;
// * ar:阿拉伯语;
// * de:德语;
// * es:西班牙语;
// * fr:法语;
// * hi:印地语;
// * pt:葡萄牙语;
// * ru:俄语;
// * vi:越南语;
// * th:泰语。
Language string `json:"Language"`
// 字幕阴影配置
Border *CreateSubtitleTranscodePresetBodyTargetLanguageItemBorder `json:"Border,omitempty"`
}
type CreateSubtitleTranscodePresetBodyTargetLanguageItemBorder ¶ added in v1.0.32
type CreateSubtitleTranscodePresetBodyTargetLanguageItemBorder struct {
// REQUIRED; 阴影颜色
Color string `json:"Color"`
// 填0的时候后端根据字体大小进行计算,字体大小/32*1.25
Width *int32 `json:"Width,omitempty"`
}
CreateSubtitleTranscodePresetBodyTargetLanguageItemBorder - 字幕阴影配置
type CreateSubtitleTranscodePresetQuery ¶ added in v1.0.32
type CreateSubtitleTranscodePresetQuery struct{}
type CreateSubtitleTranscodePresetReq ¶ added in v1.0.32
type CreateSubtitleTranscodePresetReq struct {
*CreateSubtitleTranscodePresetQuery
*CreateSubtitleTranscodePresetBody
}
type CreateSubtitleTranscodePresetRes ¶ added in v1.0.32
type CreateSubtitleTranscodePresetRes struct {
// REQUIRED
ResponseMetadata CreateSubtitleTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type CreateSubtitleTranscodePresetResResponseMetadata ¶ added in v1.0.32
type CreateSubtitleTranscodePresetResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type CreateTimeShiftPresetV2 ¶
type CreateTimeShiftPresetV2 struct{}
type CreateTimeShiftPresetV2Body ¶
type CreateTimeShiftPresetV2Body struct {
// REQUIRED
App string `json:"App"`
// REQUIRED
MaxShiftTime int32 `json:"MaxShiftTime"`
// REQUIRED
PullDomain string `json:"PullDomain"`
// REQUIRED
Type string `json:"Type"`
// REQUIRED
Vhost string `json:"Vhost"`
Bucket *string `json:"Bucket,omitempty"`
MasterFormat *string `json:"MasterFormat,omitempty"`
}
type CreateTimeShiftPresetV2Query ¶
type CreateTimeShiftPresetV2Query struct{}
type CreateTimeShiftPresetV2Req ¶
type CreateTimeShiftPresetV2Req struct {
*CreateTimeShiftPresetV2Query
*CreateTimeShiftPresetV2Body
}
type CreateTimeShiftPresetV2Res ¶
type CreateTimeShiftPresetV2Res struct {
// REQUIRED
ResponseMetadata CreateTimeShiftPresetV2ResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type CreateTimeShiftPresetV2ResResponseMetadata ¶
type CreateTimeShiftPresetV2ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreateTimeShiftPresetV2ResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type CreateTranscodePreset ¶
type CreateTranscodePreset struct{}
type CreateTranscodePresetBody ¶
type CreateTranscodePresetBody struct {
// REQUIRED; 应用名称,取值与直播流地址的 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
// 转码后缀通常以流名称后缀的形式来使用,常见的标识有 _sd、_hd、_uhd,例如,当转码配置的标识为 _hd 时,拉取转码流时转码流的流名名称为 源流的流名称_hd。
SuffixName string `json:"SuffixName"`
// REQUIRED; 视频编码格式,支持的取值及含义如下所示。
// * h264:使用 H.264 视频编码格式;
// * h265:使用 H.265 视频编码格式;
// * h266:使用 H.266 视频编码格式;
// * copy:不进行视频转码,所有视频编码参数不生效,视频编码参数包括视频帧率(FPS)、视频码率(VideoBitrate)、分辨率设置(As、Width、Height、ShortSide、LongSide)、GOP 和 BFrames
// 等。
Vcodec string `json:"Vcodec"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要转码的直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
AbrMode *int32 `json:"AbrMode,omitempty"`
// 音频编码格式,默认值为 aac,支持的取值及含义如下所示。
// * aac:使用 AAC 音频编码格式;
// * opus:使用 Opus 音频编码格式。
// * copy:不进行音频转码,所有音频编码参数不生效,音频编码参数包括音频码率(AudioBitrate)等。
Acodec *string `json:"Acodec,omitempty"`
// 视频分辨率自适应模式开关,默认值为 0。支持的取值及含义如下。
// * 0:关闭视频分辨率自适应;
// * 1:开启视频分辨率自适应。 :::tip
// * 关闭视频分辨率自适应模式(As 取值为 0)时,转码配置的视频分辨率取视频宽度(Width)和视频高度(Height)的值对转码视频进行拉伸;
// * 开启视频分辨率自适应模式(As 取值为 1)时,转码配置的视频分辨率按照短边长度(ShortSide)、长边长度(LongSide)、视频宽度(Width)、视频高度(Height)的优先级取值,另一边等比缩放。 :::
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps,默认值为 128,取值范围为 [0,1000];取值为 0 时,表示与源流的音频码率相同。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
// 是否开启转码视频分辨率不超过源流分辨率,默认值为 1 表示开启。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
// 是否开启转码视频码率不超过源流码率,默认值为 1 表示开启。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
// 是否开启转码视频帧率不超过源流帧率,默认值为 1 表示开启。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
// 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 3,取值为 0 时表示去除 B 帧。
// 最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。
// * 视频编码格式为 H.264 (Vcodec 取值为 h264)时取值范围为 [0,7];
// * 视频编码格式为 H.265 或 H.266 (Vcodec 取值为 h265 或 h266)时取值范围为 [0,3]、7、15。
BFrames *int32 `json:"BFrames,omitempty"`
// 视频帧率,单位为 fps,默认值为 25,取值为 0 时表示与源流视频帧率相同。
// 视频帧率的取值范围根据视频编码格式(Vcodec)的不同有所差异,视频码率的取值范围如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,视频帧率取值范围为 [0,60];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,视频帧率取值范围为 [0,35]。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔时间,单位为秒,默认值为 4,取值范围为 [1,20]。
GOP *int32 `json:"GOP,omitempty"`
// 视频高度,默认值为 0。
// 视频高度的取值范围根据视频编码格式(Vcodec)的不同所有差异,视频高度取值如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,取值范围为 [150,1920];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,不支持设置 Width 和 Height。
// :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Height *int32 `json:"Height,omitempty"`
// 长边长度,默认值为 0。配置不同的转码类型(Roi)和视频编码方式(Vcodec)时,短边长度的取值范围存在如下。
// * 转码类型为标准转码(Roi 取值为 false)时: * 视频编码方式为 H.264 (Vcodec 取值为 h264)时取值范围为 0 和 [150,4096];
// * 视频编码方式为 H.265 (Vcodec 取值为 h265)时取值范围为 0 和 [150,7680];
// * 视频编码方式为 H.266 (Vcodec 取值为 h266)时取值范围为 0 和 [150,1280]。
//
//
// * 转码类型为极智超清转码(Roi 取值为 true)时: * 视频编码方式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时取值范围为 0 和 [150,1920]。
//
//
// :::tip
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,参数生效,反之则不生效。
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
// 转码类型是否为极智超清转码,默认值为 false,取值及含义如下。
// * true:极智超清转码;
// * false:标准转码。
// :::tip 视频编码格式为 H.266 (Vcodec取值为h266)时,转码类型不支持极智超清转码。 :::
Roi *bool `json:"Roi,omitempty"`
// 短边长度,默认值为 0。配置不同的转码类型(Roi)和视频编码方式(Vcodec)时,短边长度的取值范围存在如下。
// * 转码类型为标准转码(Roi 取值为 false)时: * 视频编码方式为 H.264 (Vcodec 取值为 h264)时取值范围为 0 和 [150,2160];
// * 视频编码方式为 H.265 (Vcodec 取值为 h265)时取值范围为 0 和 [150,4096];
// * 视频编码方式为 H.266 (Vcodec 取值为 h266)时取值范围为 0 和 [150,720]。
//
//
// * 转码类型为极智超清转码(Roi 取值为 true)时: * 视频编码方式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时取值范围为 0 和 [150,1920]。 :::tip
//
//
// * 当开启视频分辨率自适应模式(As 取值为 1)时,参数生效,反之则不生效。
// * 当开启视频分辨率自适应模式(As 取值为 1)时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
// 转码停止时长,支持触发方式为拉流转码(TransType 取值为 Pull)时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 -1 和 [0,300],-1 表示不停止转码,默认值为 60。
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码触发方式,默认值为 Pull,支持的取值及含义如下。
// * Push:推流转码,直播推流后会自动启动转码任务,生成转码流;
// * Pull:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。
TransType *string `json:"TransType,omitempty"`
// 视频码率,单位为 bps,默认值为 1000000;取值为 0 时,表示与源流的视频码率相同。
// 视频码率的取值范围根据视频编码格式(Vcodec)的不同有所差异,视频码率的取值范围如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,视频码率取值范围为 [0,30000000];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,视频码率取值范围为 [0,6000000]。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
// 视频宽度,单位为 px,默认值为 0。
// 视频宽度的取值范围根据视频编码格式(Vcodec)的不同所有差异,视频宽度取值如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,取值范围为 [150,1920];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,不支持设置 Width 和 Height。
// :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Width *int32 `json:"Width,omitempty"`
}
type CreateTranscodePresetQuery ¶
type CreateTranscodePresetQuery struct{}
type CreateTranscodePresetReq ¶
type CreateTranscodePresetReq struct {
*CreateTranscodePresetQuery
*CreateTranscodePresetBody
}
type CreateTranscodePresetRes ¶
type CreateTranscodePresetRes struct {
// REQUIRED
ResponseMetadata CreateTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type CreateTranscodePresetResResponseMetadata ¶
type CreateTranscodePresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreateTranscodePresetResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type CreateWatermarkPreset ¶
type CreateWatermarkPreset struct{}
type CreateWatermarkPresetBody ¶
type CreateWatermarkPresetBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。
PosX float32 `json:"PosX"`
// REQUIRED; 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。
PosY float32 `json:"PosY"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 需要添加水印的直播画面方向,支持 2 种取值。
// * vertical:竖屏;
// * horizontal:横屏。 :::tip 该参数属于历史版本参数,预计将于未来移除。建议使用预览背景高度(PreviewHeight)、预览背景宽度(PreviewWidth)参数代替。 :::
Orientation *string `json:"Orientation,omitempty"`
// 水印图片编码字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:[<mediatype>];[base64],<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
Picture *string `json:"Picture,omitempty"`
// 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入,同时传入时,以水印图片编码字符串参数为准。
PictureURL *string `json:"PictureUrl,omitempty"`
// 水印图片预览背景高度,单位为 px。
PreviewHeight *float32 `json:"PreviewHeight,omitempty"`
// 水印图片预览背景宽度,单位为 px。
PreviewWidth *float32 `json:"PreviewWidth,omitempty"`
// 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。与水印相对宽度字段冲突,请选择其中一个传参。
RelativeHeight *float32 `json:"RelativeHeight,omitempty"`
// 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。与水印相对高度字段冲突,请选择其中一个传参。
RelativeWidth *float32 `json:"RelativeWidth,omitempty"`
// 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
// :::tip
// * 默认为空,表示对指定的 AppName 下所有转码流均使用当前水印配置。
// * 指定流名称时,表示仅对 AppName 下指定流名称的转码流使用当前水印配置。 :::
Stream *string `json:"Stream,omitempty"`
}
type CreateWatermarkPresetQuery ¶
type CreateWatermarkPresetQuery struct{}
type CreateWatermarkPresetReq ¶
type CreateWatermarkPresetReq struct {
*CreateWatermarkPresetQuery
*CreateWatermarkPresetBody
}
type CreateWatermarkPresetRes ¶
type CreateWatermarkPresetRes struct {
// REQUIRED
ResponseMetadata CreateWatermarkPresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type CreateWatermarkPresetResResponseMetadata ¶
type CreateWatermarkPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *CreateWatermarkPresetResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteCMAFConfig ¶
type DeleteCMAFConfig struct{}
type DeleteCMAFConfigBody ¶
type DeleteCMAFConfigQuery ¶
type DeleteCMAFConfigQuery struct{}
type DeleteCMAFConfigReq ¶
type DeleteCMAFConfigReq struct {
*DeleteCMAFConfigQuery
*DeleteCMAFConfigBody
}
type DeleteCMAFConfigRes ¶
type DeleteCMAFConfigRes struct {
// REQUIRED
ResponseMetadata DeleteCMAFConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteCMAFConfigResResponseMetadata ¶
type DeleteCMAFConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteCallback ¶
type DeleteCallback struct{}
type DeleteCallbackBody ¶
type DeleteCallbackBody struct {
// 应用名称,与创建回调时传的值一致。您可以调用 DescribeCallback [https://www.volcengine.com/docs/6469/1126931] 接口查看待删除回调配置的 App 取值。
App *string `json:"App,omitempty"`
// 推流域名,与创建回调时传的值一致。您可以调用 DescribeCallback [https://www.volcengine.com/docs/6469/1126931] 接口查看待删除回调配置的 Domain 取值。
Domain *string `json:"Domain,omitempty"`
// 消息类型,与创建回调时传的值一致。您可以调用 DescribeCallback [https://www.volcengine.com/docs/6469/1126931] 接口查看待删除回调配置的 MessageType 取值。
// * push:推流开始回调;
// * push_end:推流结束回调;
// * snapshot:截图回调;
// * record:录制任务状态回调;
// * audit_snapshot:截图审核结果回调。
MessageType *string `json:"MessageType,omitempty"`
// 域名空间,与创建回调时传的值一致。您可以调用 DescribeCallback [https://www.volcengine.com/docs/6469/1126931] 接口查看待删除回调配置的 Vhost 取值。
Vhost *string `json:"Vhost,omitempty"`
}
type DeleteCallbackQuery ¶
type DeleteCallbackQuery struct{}
type DeleteCallbackReq ¶
type DeleteCallbackReq struct {
*DeleteCallbackQuery
*DeleteCallbackBody
}
type DeleteCallbackRes ¶
type DeleteCallbackRes struct {
// REQUIRED
ResponseMetadata DeleteCallbackResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteCallbackResResponseMetadata ¶
type DeleteCallbackResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *DeleteCallbackResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteCert ¶
type DeleteCert struct{}
type DeleteCertBody ¶
type DeleteCertBody struct {
// REQUIRED; 待删除的 HTTPS 证书的证书链 ID,可以通过查询证书列表 [https://www.volcengine.com/docs/6469/1126822]接口获取。
ChainID string `json:"ChainID"`
}
type DeleteCertQuery ¶
type DeleteCertQuery struct{}
type DeleteCertReq ¶
type DeleteCertReq struct {
*DeleteCertQuery
*DeleteCertBody
}
type DeleteCertRes ¶
type DeleteCertRes struct {
// REQUIRED
ResponseMetadata DeleteCertResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteCertResResponseMetadata ¶
type DeleteCertResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteCertResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteCloudMixTask ¶ added in v1.0.32
type DeleteCloudMixTask struct{}
type DeleteCloudMixTaskBody ¶ added in v1.0.32
type DeleteCloudMixTaskBody struct {
// REQUIRED; 混流任务 ID,您可以通过 ListCloudMixTask [https://www.volcengine.com/docs/6469/1271157] 接口获取待结束的混流任务 ID。
TaskID string `json:"TaskID"`
}
type DeleteCloudMixTaskQuery ¶ added in v1.0.32
type DeleteCloudMixTaskQuery struct{}
type DeleteCloudMixTaskReq ¶ added in v1.0.32
type DeleteCloudMixTaskReq struct {
*DeleteCloudMixTaskQuery
*DeleteCloudMixTaskBody
}
type DeleteCloudMixTaskRes ¶ added in v1.0.32
type DeleteCloudMixTaskRes struct {
// REQUIRED
ResponseMetadata DeleteCloudMixTaskResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DeleteCloudMixTaskResResult `json:"Result"`
}
type DeleteCloudMixTaskResResponseMetadata ¶ added in v1.0.32
type DeleteCloudMixTaskResResponseMetadata struct {
// REQUIRED
RequestID string `json:"RequestID"`
}
type DeleteCloudMixTaskResResult ¶ added in v1.0.32
type DeleteClusterRateLimit ¶ added in v1.0.28
type DeleteClusterRateLimit struct{}
type DeleteClusterRateLimitBody ¶ added in v1.0.28
type DeleteClusterRateLimitQuery ¶ added in v1.0.28
type DeleteClusterRateLimitQuery struct{}
type DeleteClusterRateLimitReq ¶ added in v1.0.28
type DeleteClusterRateLimitReq struct {
*DeleteClusterRateLimitQuery
*DeleteClusterRateLimitBody
}
type DeleteClusterRateLimitRes ¶ added in v1.0.28
type DeleteClusterRateLimitRes struct {
// REQUIRED
ResponseMetadata DeleteClusterRateLimitResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteClusterRateLimitResResponseMetadata ¶ added in v1.0.28
type DeleteClusterRateLimitResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteDomain ¶
type DeleteDomain struct{}
type DeleteDomainBody ¶
type DeleteDomainBody struct {
// REQUIRED; 待删除域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要待删除域名的信息。
Domain string `json:"Domain"`
}
type DeleteDomainQuery ¶
type DeleteDomainQuery struct{}
type DeleteDomainReq ¶
type DeleteDomainReq struct {
*DeleteDomainQuery
*DeleteDomainBody
}
type DeleteDomainRes ¶
type DeleteDomainRes struct {
// REQUIRED
ResponseMetadata DeleteDomainResResponseMetadata `json:"ResponseMetadata"`
}
type DeleteDomainResResponseMetadata ¶
type DeleteDomainResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteDomainResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteFormatAccessRule ¶ added in v1.0.28
type DeleteFormatAccessRule struct{}
type DeleteFormatAccessRuleBody ¶ added in v1.0.28
type DeleteFormatAccessRuleQuery ¶ added in v1.0.28
type DeleteFormatAccessRuleQuery struct{}
type DeleteFormatAccessRuleReq ¶ added in v1.0.28
type DeleteFormatAccessRuleReq struct {
*DeleteFormatAccessRuleQuery
*DeleteFormatAccessRuleBody
}
type DeleteFormatAccessRuleRes ¶ added in v1.0.28
type DeleteFormatAccessRuleRes struct {
// REQUIRED
ResponseMetadata DeleteFormatAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteFormatAccessRuleResResponseMetadata ¶ added in v1.0.28
type DeleteFormatAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteHLSConfig ¶
type DeleteHLSConfig struct{}
type DeleteHLSConfigBody ¶
type DeleteHLSConfigQuery ¶
type DeleteHLSConfigQuery struct{}
type DeleteHLSConfigReq ¶
type DeleteHLSConfigReq struct {
*DeleteHLSConfigQuery
*DeleteHLSConfigBody
}
type DeleteHLSConfigRes ¶
type DeleteHLSConfigRes struct {
// REQUIRED
ResponseMetadata DeleteHLSConfigResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteHLSConfigResResponseMetadata ¶
type DeleteHLSConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteHTTPHeaderConfig ¶
type DeleteHTTPHeaderConfig struct{}
type DeleteHTTPHeaderConfigBody ¶
type DeleteHTTPHeaderConfigBody struct {
// REQUIRED; HTTP Header 类型,您可以调用 DescribeHTTPHeaderConfig [https://www.volcengine.com/docs/6469/1232744] 接口查看 HTTP Header
// 配置的 Phase 取值。
Phase int32 `json:"Phase"`
// REQUIRED; 域名空间,您可以调用 DescribeHTTPHeaderConfig [https://www.volcengine.com/docs/6469/1232744] 接口查看 HTTP Header 配置的 Vhost
// 取值。
Vhost string `json:"Vhost"`
// 拉流域名,您可以调用 DescribeHTTPHeaderConfig [https://www.volcengine.com/docs/6469/1232744] 接口查看 HTTP Header 配置的 Domain 取值。
Domain *string `json:"Domain,omitempty"`
}
type DeleteHTTPHeaderConfigQuery ¶
type DeleteHTTPHeaderConfigQuery struct{}
type DeleteHTTPHeaderConfigReq ¶
type DeleteHTTPHeaderConfigReq struct {
*DeleteHTTPHeaderConfigQuery
*DeleteHTTPHeaderConfigBody
}
type DeleteHTTPHeaderConfigRes ¶
type DeleteHTTPHeaderConfigRes struct {
// REQUIRED
ResponseMetadata DeleteHTTPHeaderConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteHTTPHeaderConfigResResponseMetadata ¶
type DeleteHTTPHeaderConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteIPAccessRule ¶
type DeleteIPAccessRule struct{}
type DeleteIPAccessRuleBody ¶
type DeleteIPAccessRuleBody struct {
// REQUIRED; 推流域名或拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要删除
// IP 访问限制的域名。
Domain string `json:"Domain"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要删除
// IP 访问限制的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type DeleteIPAccessRuleQuery ¶
type DeleteIPAccessRuleQuery struct{}
type DeleteIPAccessRuleReq ¶
type DeleteIPAccessRuleReq struct {
*DeleteIPAccessRuleQuery
*DeleteIPAccessRuleBody
}
type DeleteIPAccessRuleRes ¶
type DeleteIPAccessRuleRes struct {
// REQUIRED
ResponseMetadata DeleteIPAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteIPAccessRuleResResponseMetadata ¶
type DeleteIPAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteLatencyConfig ¶
type DeleteLatencyConfig struct{}
type DeleteLatencyConfigBody ¶
type DeleteLatencyConfigBody struct {
// REQUIRED
Domain string `json:"Domain"`
}
type DeleteLatencyConfigQuery ¶
type DeleteLatencyConfigQuery struct{}
type DeleteLatencyConfigReq ¶
type DeleteLatencyConfigReq struct {
*DeleteLatencyConfigQuery
*DeleteLatencyConfigBody
}
type DeleteLatencyConfigRes ¶
type DeleteLatencyConfigRes struct {
// REQUIRED
ResponseMetadata DeleteLatencyConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteLatencyConfigResResponseMetadata ¶
type DeleteLatencyConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteLiveVideoQualityAnalysisTask ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTask struct{}
type DeleteLiveVideoQualityAnalysisTaskBody ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTaskQuery ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTaskQuery struct{}
type DeleteLiveVideoQualityAnalysisTaskReq ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTaskReq struct {
*DeleteLiveVideoQualityAnalysisTaskQuery
*DeleteLiveVideoQualityAnalysisTaskBody
}
type DeleteLiveVideoQualityAnalysisTaskRes ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTaskRes struct {
// REQUIRED
ResponseMetadata DeleteLiveVideoQualityAnalysisTaskResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteLiveVideoQualityAnalysisTaskResResponseMetadata ¶ added in v1.0.32
type DeleteLiveVideoQualityAnalysisTaskResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeletePullToPushGroup ¶ added in v1.0.32
type DeletePullToPushGroup struct{}
type DeletePullToPushGroupBody ¶ added in v1.0.32
type DeletePullToPushGroupBody struct {
// REQUIRED; 拉流转推群组名称,您可以调用 ListPullToPushGroup [https://www.volcengine.com/docs/6469/1327382] 接口获取群组名称。
Name string `json:"Name"`
}
type DeletePullToPushGroupQuery ¶ added in v1.0.32
type DeletePullToPushGroupQuery struct{}
type DeletePullToPushGroupReq ¶ added in v1.0.32
type DeletePullToPushGroupReq struct {
*DeletePullToPushGroupQuery
*DeletePullToPushGroupBody
}
type DeletePullToPushGroupRes ¶ added in v1.0.32
type DeletePullToPushGroupRes struct {
// REQUIRED
ResponseMetadata DeletePullToPushGroupResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeletePullToPushGroupResResponseMetadata ¶ added in v1.0.32
type DeletePullToPushGroupResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeletePullToPushTask ¶
type DeletePullToPushTask struct{}
type DeletePullToPushTaskBody ¶
type DeletePullToPushTaskBody struct {
// REQUIRED; 任务 ID,任务的唯一标识,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。
TaskID string `json:"TaskId"`
// 任务所属的群组名称,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。 :::tip
// * 使用主账号调用时,为非必填。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
}
type DeletePullToPushTaskQuery ¶
type DeletePullToPushTaskQuery struct{}
type DeletePullToPushTaskReq ¶
type DeletePullToPushTaskReq struct {
*DeletePullToPushTaskQuery
*DeletePullToPushTaskBody
}
type DeletePullToPushTaskRes ¶
type DeletePullToPushTaskRes struct {
// REQUIRED
ResponseMetadata DeletePullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
}
type DeletePullToPushTaskResResponseMetadata ¶
type DeletePullToPushTaskResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeletePullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteRecordPreset ¶
type DeleteRecordPreset struct{}
type DeleteRecordPresetBody ¶
type DeleteRecordPresetBody struct {
// REQUIRED; 录制配置的名称。可调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858] 接口查看待删除录制配置的名称。
Preset string `json:"Preset"`
// 应用名称,您可以调用ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858]接口查看待删除的录制配置 App 取值。
App *string `json:"App,omitempty"`
// 域名空间。您可以调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858] 接口查看待删除录制配置的 Vhost 取值。
Vhost *string `json:"Vhost,omitempty"`
}
type DeleteRecordPresetQuery ¶
type DeleteRecordPresetQuery struct{}
type DeleteRecordPresetReq ¶
type DeleteRecordPresetReq struct {
*DeleteRecordPresetQuery
*DeleteRecordPresetBody
}
type DeleteRecordPresetRes ¶
type DeleteRecordPresetRes struct {
// REQUIRED
ResponseMetadata DeleteRecordPresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteRecordPresetResResponseMetadata ¶
type DeleteRecordPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteRecordPresetResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteReferer ¶
type DeleteReferer struct{}
type DeleteRefererBody ¶
type DeleteRefererBody struct {
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要配置
// Referer 的拉流域名所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 :::tip
// * 如创建时传了 App,删除时需要传该参数;
// * 如创建时未传 App,删除时不传该参数。 :::
App *string `json:"App,omitempty"`
// 拉流域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要配置
// Referer 的拉流域名。 :::tip
// * 如创建时传了 Domain,删除时需要传该参数;
// * 如创建时未传 Domain,删除时不传该参数。 :::
Domain *string `json:"Domain,omitempty"`
}
type DeleteRefererQuery ¶
type DeleteRefererQuery struct{}
type DeleteRefererReq ¶
type DeleteRefererReq struct {
*DeleteRefererQuery
*DeleteRefererBody
}
type DeleteRefererRes ¶
type DeleteRefererRes struct {
// REQUIRED
ResponseMetadata DeleteRefererResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteRefererResResponseMetadata ¶
type DeleteRefererResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *DeleteRefererResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteRegionAccessRule ¶ added in v1.0.28
type DeleteRegionAccessRule struct{}
type DeleteRegionAccessRuleBody ¶ added in v1.0.28
type DeleteRegionAccessRuleQuery ¶ added in v1.0.28
type DeleteRegionAccessRuleQuery struct{}
type DeleteRegionAccessRuleReq ¶ added in v1.0.28
type DeleteRegionAccessRuleReq struct {
*DeleteRegionAccessRuleQuery
*DeleteRegionAccessRuleBody
}
type DeleteRegionAccessRuleRes ¶ added in v1.0.28
type DeleteRegionAccessRuleRes struct {
// REQUIRED
ResponseMetadata DeleteRegionAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteRegionAccessRuleResResponseMetadata ¶ added in v1.0.28
type DeleteRegionAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteRelaySourceRewrite ¶
type DeleteRelaySourceRewrite struct{}
type DeleteRelaySourceRewriteQuery ¶
type DeleteRelaySourceRewriteQuery struct{}
type DeleteRelaySourceRewriteReq ¶
type DeleteRelaySourceRewriteReq struct {
*DeleteRelaySourceRewriteQuery
*DeleteRelaySourceRewriteBody
}
type DeleteRelaySourceRewriteRes ¶
type DeleteRelaySourceRewriteRes struct {
// REQUIRED
ResponseMetadata DeleteRelaySourceRewriteResResponseMetadata `json:"ResponseMetadata"`
Result *DeleteRelaySourceRewriteResResult `json:"Result,omitempty"`
}
type DeleteRelaySourceRewriteResResponseMetadata ¶
type DeleteRelaySourceRewriteResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteRelaySourceRewriteResResult ¶
type DeleteRelaySourceRewriteResResult struct {
// REQUIRED; 异动列表
Items []interface{} `json:"Items"`
}
type DeleteRelaySourceV3 ¶
type DeleteRelaySourceV3 struct{}
type DeleteRelaySourceV3Body ¶
type DeleteRelaySourceV3Body struct {
// REQUIRED; 直播流使用的域名所属的域名空间,您可以调用DescribeRelaySourceV3 [https://www.volcengine.com/docs/6469/1126874]接口获取待删除配置的 Vhost 取值。
Vhost string `json:"Vhost"`
// 应用名称,您可以调用DescribeRelaySourceV3 [https://www.volcengine.com/docs/6469/1126874]接口获取待删除配置的 App 取值。
App *string `json:"App,omitempty"`
// 回源组名称。
Group *string `json:"Group,omitempty"`
}
type DeleteRelaySourceV3Query ¶
type DeleteRelaySourceV3Query struct{}
type DeleteRelaySourceV3Req ¶
type DeleteRelaySourceV3Req struct {
*DeleteRelaySourceV3Query
*DeleteRelaySourceV3Body
}
type DeleteRelaySourceV3Res ¶
type DeleteRelaySourceV3Res struct {
// REQUIRED
ResponseMetadata DeleteRelaySourceV3ResResponseMetadata `json:"ResponseMetadata"`
}
type DeleteRelaySourceV3ResResponseMetadata ¶
type DeleteRelaySourceV3ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteRelaySourceV3ResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteSnapshotPreset ¶
type DeleteSnapshotPreset struct{}
type DeleteSnapshotPresetBody ¶
type DeleteSnapshotPresetBody struct {
// REQUIRED; 截图配置的名称,您可以调用 ListVhostSnapshotPresetV2 [https://www.volcengine.com/docs/6469/1208858] 接口获取,取值与 Name 字段取值相同。
Preset string `json:"Preset"`
// 应用名称,您可以调用ListVhostSnapshotPresetV2 [https://www.volcengine.com/docs/6469/1208858]接口,获取待更新截图配置的 App 取值。
App *string `json:"App,omitempty"`
// 域名空间,您可以调用 ListVhostSnapshotPresetV2 [https://www.volcengine.com/docs/6469/1208858] 接口,获取待删除截图配置的 Vhost 取值。
Vhost *string `json:"Vhost,omitempty"`
}
type DeleteSnapshotPresetQuery ¶
type DeleteSnapshotPresetQuery struct{}
type DeleteSnapshotPresetReq ¶
type DeleteSnapshotPresetReq struct {
*DeleteSnapshotPresetQuery
*DeleteSnapshotPresetBody
}
type DeleteSnapshotPresetRes ¶
type DeleteSnapshotPresetRes struct {
// REQUIRED
ResponseMetadata DeleteSnapshotPresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteSnapshotPresetResResponseMetadata ¶
type DeleteSnapshotPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteSnapshotPresetResResponseMetadataError `json:"Error,omitempty"`
}
type DeleteSubtitleTranscodePreset ¶ added in v1.0.32
type DeleteSubtitleTranscodePreset struct{}
type DeleteSubtitleTranscodePresetBody ¶ added in v1.0.32
type DeleteSubtitleTranscodePresetBody struct {
// REQUIRED; 火山必填
App string `json:"App"`
// REQUIRED; 截图配置的名称,您可以调用 ListVhostSubtitleTranscodePreset [https://www.volcengine.com/docs/6469/1288712] 接口,获取待删除字幕配置的 PresetName
// 取值。
PresetName string `json:"PresetName"`
// REQUIRED; 火山必填
Vhost string `json:"Vhost"`
}
type DeleteSubtitleTranscodePresetQuery ¶ added in v1.0.32
type DeleteSubtitleTranscodePresetQuery struct{}
type DeleteSubtitleTranscodePresetReq ¶ added in v1.0.32
type DeleteSubtitleTranscodePresetReq struct {
*DeleteSubtitleTranscodePresetQuery
*DeleteSubtitleTranscodePresetBody
}
type DeleteSubtitleTranscodePresetRes ¶ added in v1.0.32
type DeleteSubtitleTranscodePresetRes struct {
// REQUIRED
ResponseMetadata DeleteSubtitleTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteSubtitleTranscodePresetResResponseMetadata ¶ added in v1.0.32
type DeleteSubtitleTranscodePresetResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteTimeShiftPresetV2 ¶
type DeleteTimeShiftPresetV2 struct{}
type DeleteTimeShiftPresetV2Query ¶
type DeleteTimeShiftPresetV2Query struct{}
type DeleteTimeShiftPresetV2Req ¶
type DeleteTimeShiftPresetV2Req struct {
*DeleteTimeShiftPresetV2Query
*DeleteTimeShiftPresetV2Body
}
type DeleteTimeShiftPresetV2Res ¶
type DeleteTimeShiftPresetV2Res struct {
// REQUIRED
ResponseMetadata DeleteTimeShiftPresetV2ResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteTimeShiftPresetV2ResResponseMetadata ¶
type DeleteTimeShiftPresetV2ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteTimeShiftPresetV2ResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type DeleteTranscodePreset ¶
type DeleteTranscodePreset struct{}
type DeleteTranscodePresetBody ¶
type DeleteTranscodePresetBody struct {
// REQUIRED; 应用名称,您可以调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853] 接口查看待删除转码配置的 App 取值。
App string `json:"App"`
// REQUIRED; 转码配置名称,您可以调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853] 接口查看待删除转码配置的 Preset 取值。
Preset string `json:"Preset"`
// REQUIRED; 域名空间,您可以调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853] 接口查看待删除转码配置的 Vhost 取值。
Vhost string `json:"Vhost"`
}
type DeleteTranscodePresetQuery ¶
type DeleteTranscodePresetQuery struct{}
type DeleteTranscodePresetReq ¶
type DeleteTranscodePresetReq struct {
*DeleteTranscodePresetQuery
*DeleteTranscodePresetBody
}
type DeleteTranscodePresetRes ¶
type DeleteTranscodePresetRes struct {
// REQUIRED
ResponseMetadata DeleteTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type DeleteTranscodePresetResResponseMetadata ¶
type DeleteTranscodePresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteTranscodePresetResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type DeleteUserAgentAccessRule ¶ added in v1.0.28
type DeleteUserAgentAccessRule struct{}
type DeleteUserAgentAccessRuleBody ¶ added in v1.0.28
type DeleteUserAgentAccessRuleQuery ¶ added in v1.0.28
type DeleteUserAgentAccessRuleQuery struct{}
type DeleteUserAgentAccessRuleReq ¶ added in v1.0.28
type DeleteUserAgentAccessRuleReq struct {
*DeleteUserAgentAccessRuleQuery
*DeleteUserAgentAccessRuleBody
}
type DeleteUserAgentAccessRuleRes ¶ added in v1.0.28
type DeleteUserAgentAccessRuleRes struct {
// REQUIRED
ResponseMetadata DeleteUserAgentAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DeleteUserAgentAccessRuleResResponseMetadata ¶ added in v1.0.28
type DeleteUserAgentAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DeleteWatermarkPreset ¶
type DeleteWatermarkPreset struct{}
type DeleteWatermarkPresetBody ¶
type DeleteWatermarkPresetBody struct {
// REQUIRED; 应用名称,您可以调用ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889]接口,查看待删除水印配置的 App 取值。
App string `json:"App"`
// REQUIRED; 域名空间,您可以调用 ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889] 接口,查看待删除水印配置的 Vhost 取值。
Vhost string `json:"Vhost"`
// 流名称,您可以调用ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889]接口,查看待删除水印配置的 Stream 取值。
Stream *string `json:"Stream,omitempty"`
}
type DeleteWatermarkPresetQuery ¶
type DeleteWatermarkPresetQuery struct{}
type DeleteWatermarkPresetReq ¶
type DeleteWatermarkPresetReq struct {
*DeleteWatermarkPresetQuery
*DeleteWatermarkPresetBody
}
type DeleteWatermarkPresetRes ¶
type DeleteWatermarkPresetRes struct {
// REQUIRED
ResponseMetadata DeleteWatermarkPresetResResponseMetadata `json:"ResponseMetadata"`
}
type DeleteWatermarkPresetResResponseMetadata ¶
type DeleteWatermarkPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DeleteWatermarkPresetResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeAuth ¶
type DescribeAuth struct{}
type DescribeAuthBody ¶
type DescribeAuthBody struct {
// REQUIRED; 鉴权场景类型,取值及含义如下所示。
// * push:推流鉴权;
// * pull:拉流鉴权。
SceneType string `json:"SceneType"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty"`
// 直播流使用的域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看待配置鉴权的推拉流域名。
// :::tip 参数 Domain 和 Vhost 传且仅传一个。
// :::
Domain *string `json:"Domain,omitempty"`
// 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的直播流使用的域名所属的域名空间。
// :::tip 参数
// Domain 和 Vhost 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeAuthQuery ¶
type DescribeAuthQuery struct{}
type DescribeAuthReq ¶
type DescribeAuthReq struct {
*DescribeAuthQuery
*DescribeAuthBody
}
type DescribeAuthRes ¶
type DescribeAuthRes struct {
// REQUIRED
ResponseMetadata DescribeAuthResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeAuthResResult `json:"Result,omitempty"`
}
type DescribeAuthResResponseMetadata ¶
type DescribeAuthResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeAuthResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeAuthResResult ¶
type DescribeAuthResResult struct {
// 推/拉流鉴权列表。
AuthList []*DescribeAuthResResultAuthListItem `json:"AuthList,omitempty"`
}
type DescribeAuthResResultAuthListItem ¶
type DescribeAuthResResultAuthListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 是否开启 URL 地址鉴权,取值及含义如下所示。
// * false:关闭;
// * true:开启。
AuthStatus bool `json:"AuthStatus"`
// REQUIRED; 推/拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 鉴权场景类型,取值及含义如下所示。
// * push:推流鉴权;
// * pull:拉流鉴权。
SceneType string `json:"SceneType"`
// REQUIRED; 鉴权生效时长,单位为秒。
ValidDuration int32 `json:"ValidDuration"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
// 鉴权详情。
AuthDetailList []*DescribeAuthResResultAuthListPropertiesItemsItem `json:"AuthDetailList,omitempty"`
}
type DescribeAuthResResultAuthListPropertiesItemsItem ¶
type DescribeAuthResResultAuthListPropertiesItemsItem struct {
// 自定义推拉流地址中,鉴权参数volcSecret和volcTime的名称。
AuthField map[string]*string `json:"AuthField,omitempty"`
// 生成加密字符串使用的加密字段。
EncryptField []*string `json:"EncryptField,omitempty"`
// 对称加密算法。
EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitempty"`
// 自定义鉴权密钥。
SecretKey *string `json:"SecretKey,omitempty"`
}
DescribeAuthResResultAuthListPropertiesItemsItem - 鉴权详情。
type DescribeCDNSnapshotHistory ¶
type DescribeCDNSnapshotHistory struct{}
type DescribeCDNSnapshotHistoryBody ¶
type DescribeCDNSnapshotHistoryBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 :::tip
// * 当您查询指定截图任务详情时,DateFrom 应设置为推流开始时间之前的任意时间。
// * 查询的最大时间跨度为 7 天。 :::
DateFrom string `json:"DateFrom"`
// REQUIRED; 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
DateTo string `json:"DateTo"`
// REQUIRED; 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream string `json:"Stream"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 查询数据的页码,默认为 1,表示查询第一页的数据。
PageNum *int32 `json:"PageNum,omitempty"`
// 每页显示的数据条数,默认为 10,最大值为 1000。
PageSize *int32 `json:"PageSize,omitempty"`
// 截图文件保存位置,取值及含义如下所示。
// * tos:(默认值)TOS 对象存储服务;
// * imageX:veImageX 图片服务。
Type *string `json:"Type,omitempty"`
}
type DescribeCDNSnapshotHistoryQuery ¶
type DescribeCDNSnapshotHistoryQuery struct{}
type DescribeCDNSnapshotHistoryReq ¶
type DescribeCDNSnapshotHistoryReq struct {
*DescribeCDNSnapshotHistoryQuery
*DescribeCDNSnapshotHistoryBody
}
type DescribeCDNSnapshotHistoryRes ¶
type DescribeCDNSnapshotHistoryRes struct {
// REQUIRED
ResponseMetadata DescribeCDNSnapshotHistoryResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeCDNSnapshotHistoryResResult `json:"Result,omitempty"`
}
type DescribeCDNSnapshotHistoryResResponseMetadata ¶
type DescribeCDNSnapshotHistoryResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeCDNSnapshotHistoryResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeCDNSnapshotHistoryResResult ¶
type DescribeCDNSnapshotHistoryResResult struct {
// REQUIRED; 分页信息。
Pagination DescribeCDNSnapshotHistoryResResultPagination `json:"Pagination"`
// 截图文件信息。
Data []*DescribeCDNSnapshotHistoryResResultDataItem `json:"Data,omitempty"`
}
type DescribeCDNSnapshotHistoryResResultDataItem ¶
type DescribeCDNSnapshotHistoryResResultDataItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 截图高度,单位为 px。
Height int32 `json:"Height"`
// REQUIRED
ID int32 `json:"ID"`
// REQUIRED; 截图文件保存的路径。
Path string `json:"Path"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
// REQUIRED; 截图时间戳,精度为毫秒。
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// REQUIRED; 截图宽度,单位为 px。
Width int32 `json:"Width"`
}
type DescribeCDNSnapshotHistoryResResultPagination ¶
type DescribeCDNSnapshotHistoryResResultPagination struct {
// REQUIRED; 查询数据的页码。
PageCur int32 `json:"PageCur"`
// REQUIRED; 每页显示的数据量条数。
PageSize int32 `json:"PageSize"`
// REQUIRED; 查询结果的数据总页数。
PageTotal int32 `json:"PageTotal"`
// REQUIRED; 查询结果的数据总条数。
TotalCount int32 `json:"TotalCount"`
}
DescribeCDNSnapshotHistoryResResultPagination - 分页信息。
type DescribeCMAFConfig ¶
type DescribeCMAFConfig struct{}
type DescribeCMAFConfigBody ¶
type DescribeCMAFConfigQuery ¶
type DescribeCMAFConfigQuery struct{}
type DescribeCMAFConfigReq ¶
type DescribeCMAFConfigReq struct {
*DescribeCMAFConfigQuery
*DescribeCMAFConfigBody
}
type DescribeCMAFConfigRes ¶
type DescribeCMAFConfigRes struct {
// REQUIRED
ResponseMetadata DescribeCMAFConfigResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeCMAFConfigResResult `json:"Result"`
}
type DescribeCMAFConfigResResult ¶
type DescribeCMAFConfigResResult struct {
CMAFConfigList []*DescribeCMAFConfigResResultCMAFConfigListItem `json:"CMAFConfigList,omitempty"`
}
type DescribeCMAFConfigResResultCMAFConfigListItem ¶
type DescribeCMAFConfigResResultCMAFConfigListItem struct {
// REQUIRED
CreateTime string `json:"CreateTime"`
// REQUIRED
UpdateTime string `json:"UpdateTime"`
App *string `json:"App,omitempty"`
DefaultLatency *int32 `json:"DefaultLatency,omitempty"`
DisableLowLatency *bool `json:"DisableLowLatency,omitempty"`
Interval *float32 `json:"Interval,omitempty"`
PlaylistLength *int32 `json:"PlaylistLength,omitempty"`
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeCallback ¶
type DescribeCallback struct{}
type DescribeCallbackBody ¶
type DescribeCallbackBody struct {
// domain, app二选一必传
App *string `json:"App,omitempty"`
// domain, app二选一必传
Domain *string `json:"Domain,omitempty"`
// 回调类型。默认为空,表示查询全部回调类型,取值及含义如下所示。
// * push:推流开始回调;
// * push_end:推流结束回调;
// * snapshot:截图回调;
// * record:录制回调;
// * audit_snapshot:截图审核回调。
MessageType *string `json:"MessageType,omitempty"`
// 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的直播流使用的域名所属的域名空间。
// :::tipVhost和
// Domain传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeCallbackQuery ¶
type DescribeCallbackQuery struct{}
type DescribeCallbackReq ¶
type DescribeCallbackReq struct {
*DescribeCallbackQuery
*DescribeCallbackBody
}
type DescribeCallbackRes ¶
type DescribeCallbackRes struct {
// REQUIRED
ResponseMetadata DescribeCallbackResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeCallbackResResult `json:"Result,omitempty"`
}
type DescribeCallbackResResponseMetadata ¶
type DescribeCallbackResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeCallbackResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeCallbackResResult ¶
type DescribeCallbackResResult struct {
// 回调列表。
CallbackList []*DescribeCallbackResResultCallbackListItem `json:"CallbackList,omitempty"`
}
type DescribeCallbackResResultCallbackListItem ¶
type DescribeCallbackResResultCallbackListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 回调消息发送是否开启鉴权,默认为false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
AuthEnable bool `json:"AuthEnable"`
// REQUIRED
AuthField DescribeCallbackResResultCallbackListItemAuthField `json:"AuthField"`
// REQUIRED; 回调消息发送鉴权密钥,开启回调消息鉴权时生效。
AuthKeyPrimary string `json:"AuthKeyPrimary"`
// REQUIRED; 回调创建时间
CreateTime string `json:"CreateTime"`
// REQUIRED; 格式为rfc3339,时区为utc的回调创建时间,
CreateTimeUTC string `json:"CreateTimeUTC"`
// REQUIRED; 回调的消息类型,取值及含义如下所示。
// * push:推流开始回调;
// * push_end:推流结束回调;
// * snapshot:截图回调;
// * record:录制回调;
// * audit_snapshot:截图审核回调。
MessageType string `json:"MessageType"`
// REQUIRED; 是否开启转码流回调,默认为 0。取值及含义如下所示。
// * 0:不开启;
// * 1:开启。
TranscodeCallback int32 `json:"TranscodeCallback"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
AuthKeySecond *string `json:"AuthKeySecond,omitempty"`
// 回调数据列表。
CallbackDetailList []*DescribeCallbackResResultCallbackListPropertiesItemsItem `json:"CallbackDetailList,omitempty"`
CallbackField []*string `json:"CallbackField,omitempty"`
Domain *string `json:"Domain,omitempty"`
EncryptField []*string `json:"EncryptField,omitempty"`
EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitempty"`
HTTPMethod *string `json:"HttpMethod,omitempty"`
NotUseVhost *bool `json:"NotUseVhost,omitempty"`
RetryInternalSecond *int32 `json:"RetryInternalSecond,omitempty"`
RetryTimes *int32 `json:"RetryTimes,omitempty"`
SecHandlerType *string `json:"SecHandlerType,omitempty"`
// 任务状态回调开关
TaskStatusCallback *int32 `json:"TaskStatusCallback,omitempty"`
TimeoutSecond *int32 `json:"TimeoutSecond,omitempty"`
ValidDuration *int32 `json:"ValidDuration,omitempty"`
}
type DescribeCertDRM ¶
type DescribeCertDRM struct{}
type DescribeCertDRMBody ¶
type DescribeCertDRMBody struct{}
type DescribeCertDRMQuery ¶
type DescribeCertDRMQuery struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App" query:"App"`
// REQUIRED; 域名空间,即直播流地址的域名(Domain)所属的域名空间(Vhost)。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost" query:"Vhost"`
}
type DescribeCertDRMReq ¶
type DescribeCertDRMReq struct {
*DescribeCertDRMQuery
*DescribeCertDRMBody
}
type DescribeCertDRMRes ¶
type DescribeCertDRMRes struct {
// REQUIRED
ResponseMetadata DescribeCertDRMResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DescribeCertDRMResResponseMetadata ¶
type DescribeCertDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeCertDetailSecretV2 ¶
type DescribeCertDetailSecretV2 struct{}
type DescribeCertDetailSecretV2Body ¶
type DescribeCertDetailSecretV2Body struct {
// 账号ID
AccountID *string `json:"AccountID,omitempty"`
// 证书 ID,您可以通过ListCertV2 [https://www.volcengine.com/docs/6469/1126823]接口获取证书 ID。 :::tip 参数ChainID与CertID传且仅传一个。 :::
CertID *string `json:"CertID,omitempty"`
// 证书链 ID,您可以通过ListcCertV2 [https://www.volcengine.com/docs/6469/1126823]接口获取 证书链 ID。 :::tip 参数ChainID与CertID传且仅传一个。 :::
ChainID *string `json:"ChainID,omitempty"`
}
type DescribeCertDetailSecretV2Query ¶
type DescribeCertDetailSecretV2Query struct{}
type DescribeCertDetailSecretV2Req ¶
type DescribeCertDetailSecretV2Req struct {
*DescribeCertDetailSecretV2Query
*DescribeCertDetailSecretV2Body
}
type DescribeCertDetailSecretV2Res ¶
type DescribeCertDetailSecretV2Res struct {
// REQUIRED
ResponseMetadata DescribeCertDetailSecretV2ResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeCertDetailSecretV2ResResult `json:"Result,omitempty"`
}
type DescribeCertDetailSecretV2ResResponseMetadata ¶
type DescribeCertDetailSecretV2ResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *DescribeCertDetailSecretV2ResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeCertDetailSecretV2ResResult ¶
type DescribeCertDetailSecretV2ResResult struct {
// REQUIRED; 与证书绑定的域名列表。
CertDomainList []string `json:"CertDomainList"`
// REQUIRED; 证书名称。
CertName string `json:"CertName"`
// REQUIRED; 证书链 ID。
ChainID string `json:"ChainID"`
// REQUIRED; 证书的过期时间,RFC3339 格式的 UTC 时间,精度为秒。
NotAfter string `json:"NotAfter"`
// REQUIRED; 证书的生效日期,RFC3339 格式的 UTC 时间,精度为秒。
NotBefore string `json:"NotBefore"`
// REQUIRED; 证书状态,取值及含义如下所示。
// * OK:正常;
// * Expire:过期;
// * 30days:有效期剩余 30 天;
// * 15days:有效期剩余 15 天;
// * 7days:有效期剩余 7 天;
// * 1days:有效期剩余 1 天。
Status string `json:"Status"`
// 加密算法
EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitempty"`
// 证书指纹(SHA1)
FingerprintSHA1 *string `json:"FingerprintSHA1,omitempty"`
// 证书指纹(SHA256)
FingerprintSHA256 *string `json:"FingerprintSHA256,omitempty"`
// 签发者信息
Issuer *string `json:"Issuer,omitempty"`
// openssl解析结果
OpenSSLFormat *string `json:"OpenSSLFormat,omitempty"`
// 证书详细信息。
SSL *DescribeCertDetailSecretV2ResResultSSL `json:"SSL,omitempty"`
// 签名算法
SignatureAlgorithm *string `json:"SignatureAlgorithm,omitempty"`
}
DescribeCertDetailSecretV2ResResult - 视请求的接口而定
type DescribeCertDetailSecretV2ResResultSSL ¶
type DescribeCertDetailSecretV2ResResultSSL struct {
// REQUIRED; 证书链,包括叶子证书(服务器证书)、中间证书(中间 CA 证书)以及根证书(根 CA 证书)。证书链中的证书使用 PEM 编码格式。
Chain []string `json:"Chain"`
// REQUIRED; 密钥类型,默认为rsa。
KeyType string `json:"KeyType"`
// REQUIRED; 证书私钥
PrivateKey string `json:"PrivateKey"`
// 证书链解析后的证书链简短信息。
ChainBriefInfo []*DescribeCertDetailSecretV2ResResultSSLChainBriefInfoItem `json:"ChainBriefInfo,omitempty"`
}
DescribeCertDetailSecretV2ResResultSSL - 证书详细信息。
type DescribeCertDetailSecretV2ResResultSSLChainBriefInfoItem ¶
type DescribeCertDetailSecretV2ResResultSSLChainBriefInfoItem struct {
// 加密算法
EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitempty"`
// 证书指纹(SHA1)
FingerprintSHA1 *string `json:"FingerprintSHA1,omitempty"`
// 证书指纹(SHA256)
FingerprintSHA256 *string `json:"FingerprintSHA256,omitempty"`
// 签发者信息
Issuer *string `json:"Issuer,omitempty"`
// 签名算法
SignatureAlgorithm *string `json:"SignatureAlgorithm,omitempty"`
// 主题信息
Subject *string `json:"Subject,omitempty"`
}
type DescribeClosedStreamInfoByPage ¶
type DescribeClosedStreamInfoByPage struct{}
type DescribeClosedStreamInfoByPageBody ¶
type DescribeClosedStreamInfoByPageBody struct{}
type DescribeClosedStreamInfoByPageQuery ¶
type DescribeClosedStreamInfoByPageQuery struct {
// REQUIRED; 查询的起始时间,RFC3339 格式的时间戳,精度为秒。筛选直播流结束时间符合查询条件的历史流。
EndTimeFrom string `json:"EndTimeFrom" query:"EndTimeFrom"`
// REQUIRED; 查询的结束时间,RFC3339 格式表示的时间戳,精度为秒。筛选直播流结束时间符合查询条件的历史流。
EndTimeTo string `json:"EndTimeTo" query:"EndTimeTo"`
// REQUIRED; 查询数据的页码,取值范围为正整数。
PageNum int32 `json:"PageNum" query:"PageNum"`
// REQUIRED; 每页显示的数据条数,取值范围为 [1,1000]。
PageSize int32 `json:"PageSize" query:"PageSize"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示查询所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty" query:"App"`
// 直播流使用的域名,默认为空,表示查询所有当前域名空间下的历史直播流。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的历史直播流使用的域名。
Domain *string `json:"Domain,omitempty" query:"Domain"`
// 想要查询的目标信息,使用英文逗号作为分隔符“,”,例如,bitrate,framerate。缺省情况下表示 bitrate,framerate。支持如下取值。 all:所有信息;onlineuser:在线人数;bandwidth:带宽信息;bitrate:码率信息;framerate:帧率信息;.
InfoType *string `json:"InfoType,omitempty" query:"InfoType"`
// 使用流名称进行查询的方式,默认值为 strict,支持的取值即含义如下所示。
// * fuzzy:模糊匹配;
// * strict:精准匹配。
QueryType *string `json:"QueryType,omitempty" query:"QueryType"`
// 排列方式,根据直播流结束时间排序,默认值为 desc,支持的取值及含义如下所示。
// * asc:从时间最远到最近排序;
// * desc:从时间最近到最远排序。
Sort *string `json:"Sort,omitempty" query:"Sort"`
// 历史直播流的来源类型,默认为空,表示查询所有来源类型,支持的取值及含义如下所示。
// * push:直推流;
// * relay:回源流。
SourceType *string `json:"SourceType,omitempty" query:"SourceType"`
// 流名称,取值与直播流地址中 StreamName 字段取值相同,默认为空表示查询所有流名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream *string `json:"Stream,omitempty" query:"Stream"`
// 流类型,缺省情况下表示全选。支持如下取值。Origin:原始流;trans:转码流。.
StreamType *string `json:"StreamType,omitempty" query:"StreamType"`
// 域名空间,即直播流地址的域名所属的域名空间,默认为空,表示查询所有域名空间下的历史直播流。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]
// 页面,查看需要查询的历史直播流使用的域名所属的域名空间。
Vhost *string `json:"Vhost,omitempty" query:"Vhost"`
}
type DescribeClosedStreamInfoByPageReq ¶
type DescribeClosedStreamInfoByPageReq struct {
*DescribeClosedStreamInfoByPageQuery
*DescribeClosedStreamInfoByPageBody
}
type DescribeClosedStreamInfoByPageRes ¶
type DescribeClosedStreamInfoByPageRes struct {
// REQUIRED
ResponseMetadata DescribeClosedStreamInfoByPageResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeClosedStreamInfoByPageResResult `json:"Result,omitempty"`
}
type DescribeClosedStreamInfoByPageResResponseMetadata ¶
type DescribeClosedStreamInfoByPageResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeClosedStreamInfoByPageResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeClosedStreamInfoByPageResResult ¶
type DescribeClosedStreamInfoByPageResResult struct {
// REQUIRED; 查询结果中历史流的数量。
RoughCount int32 `json:"RoughCount"`
// 历史直播流信息列表。
StreamInfoList []*DescribeClosedStreamInfoByPageResResultStreamInfoListItem `json:"StreamInfoList,omitempty"`
}
type DescribeClosedStreamInfoByPageResResultStreamInfoListItem ¶
type DescribeClosedStreamInfoByPageResResultStreamInfoListItem struct {
// REQUIRED; 历史直播流使用的应用名称。
App string `json:"App"`
// REQUIRED; 历史直播流使用的域名。
Domain string `json:"Domain"`
// REQUIRED; 直播流的结束时间,RFC3339 格式的 UTC 时间戳,精度为秒。
EndTime string `json:"EndTime"`
// REQUIRED; 历史直播流的来源类型,取值及含义如下所示。
// * push:直推流;
// * relay:回源流。
SourceType string `json:"SourceType"`
// REQUIRED; 直播流的开始时间,RFC3339 格式的 UTC 时间戳,精度为秒。
StartTime string `json:"StartTime"`
// REQUIRED; 历史直播流使用的流名称。
Stream string `json:"Stream"`
// REQUIRED; 历史直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type DescribeClusterRateLimit ¶ added in v1.0.28
type DescribeClusterRateLimit struct{}
type DescribeClusterRateLimitBody ¶ added in v1.0.28
type DescribeClusterRateLimitQuery ¶ added in v1.0.28
type DescribeClusterRateLimitQuery struct{}
type DescribeClusterRateLimitReq ¶ added in v1.0.28
type DescribeClusterRateLimitReq struct {
*DescribeClusterRateLimitQuery
*DescribeClusterRateLimitBody
}
type DescribeClusterRateLimitRes ¶ added in v1.0.28
type DescribeClusterRateLimitRes struct {
// REQUIRED
ResponseMetadata DescribeClusterRateLimitResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeClusterRateLimitResResult `json:"Result"`
}
type DescribeClusterRateLimitResResponseMetadata ¶ added in v1.0.28
type DescribeClusterRateLimitResResult ¶ added in v1.0.28
type DescribeClusterRateLimitResResult struct {
// REQUIRED
ClusterRateLimitItemList []DescribeClusterRateLimitResResultClusterRateLimitItemListItem `json:"ClusterRateLimitItemList"`
}
type DescribeClusterRateLimitResResultClusterRateLimitItemListItem ¶ added in v1.0.28
type DescribeClusterRateLimitResResultClusterRateLimitItemListItem struct {
AggregationPeriod *int32 `json:"AggregationPeriod,omitempty"`
App *string `json:"App,omitempty"`
Domain *string `json:"Domain,omitempty"`
Limit *int32 `json:"Limit,omitempty"`
Param *string `json:"Param,omitempty"`
RejectCode *int32 `json:"RejectCode,omitempty"`
RejectDuration *int32 `json:"RejectDuration,omitempty"`
Status *int32 `json:"Status,omitempty"`
Type *string `json:"Type,omitempty"`
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeDomain ¶
type DescribeDomain struct{}
type DescribeDomainBody ¶
type DescribeDomainBody struct {
// REQUIRED; 待查询域名信息的域名列表。
DomainList []string `json:"DomainList"`
}
type DescribeDomainQuery ¶
type DescribeDomainQuery struct{}
type DescribeDomainReq ¶
type DescribeDomainReq struct {
*DescribeDomainQuery
*DescribeDomainBody
}
type DescribeDomainRes ¶
type DescribeDomainRes struct {
// REQUIRED
ResponseMetadata DescribeDomainResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeDomainResResult `json:"Result,omitempty"`
}
type DescribeDomainResResponseMetadata ¶
type DescribeDomainResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeDomainResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeDomainResResult ¶
type DescribeDomainResResult struct {
// 域名详细信息列表。
DomainList []*DescribeDomainResResultDomainListItem `json:"DomainList,omitempty"`
}
type DescribeDomainResResultDomainListItem ¶
type DescribeDomainResResultDomainListItem struct {
// REQUIRED; CNAME 信息。
CNAME string `json:"CNAME"`
// REQUIRED; 绑定的 HTTPS 证书支持的泛域名。
CertDomain string `json:"CertDomain"`
// REQUIRED; 绑定的证书名称。
CertName string `json:"CertName"`
// REQUIRED; 绑定的 HTTPS 证书的证书链 ID 信息。
ChainID string `json:"ChainID"`
// REQUIRED; CNAME 状态。
// * 0:未配置 CNAME;
// * 1:已配置 CNAME。
CnameCheck int32 `json:"CnameCheck"`
// REQUIRED; 域名添加时间,RFC3339 格式的 UTC 时间戳,精度为秒。
CreateTime string `json:"CreateTime"`
// REQUIRED; 推/拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 域名是否可用的状态。
// * 0:正常,域名为可用状态;
// * 1:配置中,域名为可用状态;
// * 2:不可用,域名为其他的不可用状态。
DomainCheck int32 `json:"DomainCheck"`
// REQUIRED; ICP 备案校验是否通过,是否过期信息。
// * 1:备案正常,未过期;
// * 2:查存不到备案信息。
ICPCheck int32 `json:"ICPCheck"`
// REQUIRED; 当前域名所属的域名空间下的推流域名。
PushDomain string `json:"PushDomain"`
// REQUIRED; 域名加速区域,包含以下类型。
// * cn:中国内地;
// * cn-global:全球加速;
// * cn-oversea:海外及港澳台。
Region string `json:"Region"`
// REQUIRED; 域名状态。状态说明如下所示。
// * 0:正常;
// * 1:审核中;
// * 2:禁用,禁止使用,此时域名加速不生效;
// * 3:删除;
// * 4:审核被驳回,审核不通过,需要重新创建并审核;
// * 5:欠费关停。
Status int32 `json:"Status"`
// REQUIRED; 域名类型,包含两种类型。
// * push:推流域名;
// * pull-flv:拉流域名,包含 RTMP、FLV、HLS 格式。
Type string `json:"Type"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type DescribeEncryptDRM ¶
type DescribeEncryptDRM struct{}
type DescribeEncryptDRMBody ¶
type DescribeEncryptDRMBody struct{}
type DescribeEncryptDRMQuery ¶
type DescribeEncryptDRMQuery struct{}
type DescribeEncryptDRMReq ¶
type DescribeEncryptDRMReq struct {
*DescribeEncryptDRMQuery
*DescribeEncryptDRMBody
}
type DescribeEncryptDRMRes ¶
type DescribeEncryptDRMRes struct {
// REQUIRED
ResponseMetadata DescribeEncryptDRMResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeEncryptDRMResResult `json:"Result"`
}
type DescribeEncryptDRMResResult ¶
type DescribeEncryptDRMResResult struct {
// REQUIRED; DRM 加密配置列表。
DRMItem DescribeEncryptDRMResResultDRMItem `json:"DRMItem"`
}
type DescribeEncryptDRMResResultDRMItem ¶
type DescribeEncryptDRMResResultDRMItem struct {
// REQUIRED; DRM 证书管理平台 API 访问密钥。
APIKey string `json:"APIKey"`
// REQUIRED; 申请 FairPlay 证书过程中 Apple 返回的 ASk(Application Secret Key)字符串。
ApplicationSecretKey string `json:"ApplicationSecretKey"`
// REQUIRED; FairPlay 证书文件的名称。
CertificateFileName string `json:"CertificateFileName"`
// REQUIRED; 自定义的 FairPlay 证书名称。
CertificateName string `json:"CertificateName"`
// REQUIRED; 申请 FairPlay 证书时创建的私钥文件密钥。
PrivateKey string `json:"PrivateKey"`
// REQUIRED; 申请 FairPlay 证书时创建的私钥文件名称。
PrivateKeyFileName string `json:"PrivateKeyFileName"`
}
DescribeEncryptDRMResResultDRMItem - DRM 加密配置列表。
type DescribeEncryptHLS ¶ added in v1.0.32
type DescribeEncryptHLS struct{}
type DescribeEncryptHLSBody ¶ added in v1.0.32
type DescribeEncryptHLSBody struct{}
type DescribeEncryptHLSQuery ¶ added in v1.0.32
type DescribeEncryptHLSQuery struct{}
type DescribeEncryptHLSReq ¶ added in v1.0.32
type DescribeEncryptHLSReq struct {
*DescribeEncryptHLSQuery
*DescribeEncryptHLSBody
}
type DescribeEncryptHLSRes ¶ added in v1.0.32
type DescribeEncryptHLSRes struct {
// REQUIRED
ResponseMetadata DescribeEncryptHLSResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeEncryptHLSResResult `json:"Result,omitempty"`
}
type DescribeEncryptHLSResResponseMetadata ¶ added in v1.0.32
type DescribeEncryptHLSResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeEncryptHLSResResult ¶ added in v1.0.32
type DescribeEncryptHLSResResult struct {
// REQUIRED; 视频直播服务端生成密钥的更新周期,单位为秒,取值范围为 [60,604800]。
CycleTime float32 `json:"CycleTime"`
// REQUIRED; 客户自建密钥管理服务后,客户端向密钥管理服务请求获取密钥的地址。
URL string `json:"URL"`
}
DescribeEncryptHLSResResult - 视请求的接口而定
type DescribeForbiddenStreamInfoByPage ¶
type DescribeForbiddenStreamInfoByPage struct{}
type DescribeForbiddenStreamInfoByPageBody ¶
type DescribeForbiddenStreamInfoByPageBody struct{}
type DescribeForbiddenStreamInfoByPageQuery ¶
type DescribeForbiddenStreamInfoByPageQuery struct {
// REQUIRED; 查询数据的页码,取值范围为正整数。
PageNum int32 `json:"PageNum" query:"PageNum"`
// REQUIRED; 每页显示的数据条数,取值范围为 [1,1000]。
PageSize int32 `json:"PageSize" query:"PageSize"`
// 应用名称,取值与禁推直播流时设置的应用名称相同,默认为空,表示查询当前域名空间下所有的禁推流。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty" query:"App"`
// 直播流使用的域名,取值与禁推直播流时设置的应用名称相同,默认为空,表示查询所有当前域名空间下的禁推直播流。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]
// 接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]
// 页面,查看需要查询的禁推直播流使用的域名。
Domain *string `json:"Domain,omitempty" query:"Domain"`
// 指定是否模糊匹配流名称。缺省情况为精准匹配,支持的取值及含义如下所示。
// * fuzzy:模糊匹配;
// * strict:精准匹配。
QueryType *string `json:"QueryType,omitempty" query:"QueryType"`
// 排列方式,根据推流结束时间排序,默认值为 desc,支持的取值及含义如下所示。
// * asc:从时间最远到最近排序;
// * desc:从时间最近到最远排序。
Sort *string `json:"Sort,omitempty" query:"Sort"`
// 流名称,取值与禁推直播流时设置的流名称相同,默认为空,表示查询所有流名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream *string `json:"Stream,omitempty" query:"Stream"`
// 域名空间,取值与禁推直播流时设置的域名空间相同,默认为空,表示查询所有域名空间下的禁推流。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]
// 页面,查看需要查询的禁推流使用的域名所属的域名空间。
Vhost *string `json:"Vhost,omitempty" query:"Vhost"`
}
type DescribeForbiddenStreamInfoByPageReq ¶
type DescribeForbiddenStreamInfoByPageReq struct {
*DescribeForbiddenStreamInfoByPageQuery
*DescribeForbiddenStreamInfoByPageBody
}
type DescribeForbiddenStreamInfoByPageRes ¶
type DescribeForbiddenStreamInfoByPageRes struct {
// REQUIRED
ResponseMetadata DescribeForbiddenStreamInfoByPageResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeForbiddenStreamInfoByPageResResult `json:"Result,omitempty"`
}
type DescribeForbiddenStreamInfoByPageResResponseMetadata ¶
type DescribeForbiddenStreamInfoByPageResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeForbiddenStreamInfoByPageResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeForbiddenStreamInfoByPageResResult ¶
type DescribeForbiddenStreamInfoByPageResResult struct {
// REQUIRED; 查询结果中禁推流数量。
RoughCount int32 `json:"RoughCount"`
// 禁推流的信息列表。
StreamInfoList []*DescribeForbiddenStreamInfoByPageResResultStreamInfoListItem `json:"StreamInfoList,omitempty"`
}
type DescribeForbiddenStreamInfoByPageResResultStreamInfoListItem ¶
type DescribeForbiddenStreamInfoByPageResResultStreamInfoListItem struct {
// REQUIRED; 禁推流的应用名称。
App string `json:"App"`
// REQUIRED; 禁推流被禁推的开始时间,RFC3339 格式的 UTC 时间戳,精度为秒。
CreateTime string `json:"CreateTime"`
// REQUIRED; 禁推流的域名。
Domain string `json:"Domain"`
// REQUIRED; 禁推流结束禁推的时间,RFC3339 格式的 UTC 时间戳,精度为秒。
EndTime string `json:"EndTime"`
// REQUIRED; 当前流的禁推配置是否启用。
// * true:启用;
// * false:禁用。
Status bool `json:"Status"`
// REQUIRED; 禁推流的流名称。
Stream string `json:"Stream"`
// REQUIRED; 禁推流的域名空间。
Vhost string `json:"Vhost"`
}
type DescribeFormatAccessRule ¶ added in v1.0.28
type DescribeFormatAccessRule struct{}
type DescribeFormatAccessRuleBody ¶ added in v1.0.28
type DescribeFormatAccessRuleQuery ¶ added in v1.0.28
type DescribeFormatAccessRuleQuery struct{}
type DescribeFormatAccessRuleReq ¶ added in v1.0.28
type DescribeFormatAccessRuleReq struct {
*DescribeFormatAccessRuleQuery
*DescribeFormatAccessRuleBody
}
type DescribeFormatAccessRuleRes ¶ added in v1.0.28
type DescribeFormatAccessRuleRes struct {
// REQUIRED
ResponseMetadata DescribeFormatAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeFormatAccessRuleResResult `json:"Result"`
}
type DescribeFormatAccessRuleResResponseMetadata ¶ added in v1.0.28
type DescribeFormatAccessRuleResResult ¶ added in v1.0.28
type DescribeFormatAccessRuleResResult struct {
// REQUIRED
AccessRuleLists []DescribeFormatAccessRuleResResultAccessRuleListsItem `json:"AccessRuleLists"`
}
type DescribeFormatAccessRuleResResultAccessRuleListsItem ¶ added in v1.0.28
type DescribeFormatAccessRuleResResultAccessRuleListsItem struct {
// REQUIRED
Domain string `json:"Domain"`
// REQUIRED
FormatAccessRule DescribeFormatAccessRuleResResultAccessRuleListsItemFormatAccessRule `json:"FormatAccessRule"`
// REQUIRED
Vhost string `json:"Vhost"`
}
type DescribeFormatAccessRuleResResultAccessRuleListsItemFormatAccessRule ¶ added in v1.0.28
type DescribeHLSConfig ¶
type DescribeHLSConfig struct{}
type DescribeHLSConfigBody ¶
type DescribeHLSConfigBody struct {
// REQUIRED
Vhost string `json:"Vhost"`
}
type DescribeHLSConfigQuery ¶
type DescribeHLSConfigQuery struct{}
type DescribeHLSConfigReq ¶
type DescribeHLSConfigReq struct {
*DescribeHLSConfigQuery
*DescribeHLSConfigBody
}
type DescribeHLSConfigRes ¶
type DescribeHLSConfigRes struct {
// REQUIRED
ResponseMetadata DescribeHLSConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeHLSConfigResResult `json:"Result,omitempty"`
}
type DescribeHLSConfigResResponseMetadata ¶
type DescribeHLSConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeHLSConfigResResult ¶
type DescribeHLSConfigResResult struct {
// REQUIRED
HLSConfigList []DescribeHLSConfigResResultHLSConfigListItem `json:"HLSConfigList"`
}
DescribeHLSConfigResResult - 视请求的接口而定
type DescribeHLSConfigResResultHLSConfigListItem ¶
type DescribeHLSConfigResResultHLSConfigListItem struct {
// REQUIRED
CreateTime string `json:"CreateTime"`
// REQUIRED
FirstPlaylistLength int32 `json:"FirstPlaylistLength"`
// REQUIRED
InsertPDT bool `json:"InsertPDT"`
// REQUIRED
Interval float32 `json:"Interval"`
// REQUIRED
PDTInterval string `json:"PDTInterval"`
// REQUIRED
PartTargetDuration float32 `json:"PartTargetDuration"`
// REQUIRED
PlaylistLength int32 `json:"PlaylistLength"`
// REQUIRED
UpdateTime string `json:"UpdateTime"`
// REQUIRED
Vhost string `json:"Vhost"`
}
type DescribeHTTPHeaderConfig ¶
type DescribeHTTPHeaderConfig struct{}
type DescribeHTTPHeaderConfigBody ¶
type DescribeHTTPHeaderConfigBody struct {
// REQUIRED; 0: response 1: request
Phase int32 `json:"Phase"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要域名所属的域名空间。
Vhost string `json:"Vhost"`
// 拉流域名。默认为空,表示查询 Vhost 下的全部拉流域名的 HTTP Header 配置。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看待查询的拉流域名。
Domain *string `json:"Domain,omitempty"`
}
type DescribeHTTPHeaderConfigQuery ¶
type DescribeHTTPHeaderConfigQuery struct{}
type DescribeHTTPHeaderConfigReq ¶
type DescribeHTTPHeaderConfigReq struct {
*DescribeHTTPHeaderConfigQuery
*DescribeHTTPHeaderConfigBody
}
type DescribeHTTPHeaderConfigRes ¶
type DescribeHTTPHeaderConfigRes struct {
// REQUIRED
ResponseMetadata DescribeHTTPHeaderConfigResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED; 视请求的接口而定
Result DescribeHTTPHeaderConfigResResult `json:"Result"`
}
type DescribeHTTPHeaderConfigResResponseMetadata ¶
type DescribeHTTPHeaderConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeHTTPHeaderConfigResResult ¶
type DescribeHTTPHeaderConfigResResult struct {
// REQUIRED; HTTP Header 配置信息。
HeaderConfigList []DescribeHTTPHeaderConfigResResultHeaderConfigListItem `json:"HeaderConfigList"`
}
DescribeHTTPHeaderConfigResResult - 视请求的接口而定
type DescribeHTTPHeaderConfigResResultHeaderConfigListItem ¶
type DescribeHTTPHeaderConfigResResultHeaderConfigListItem struct {
// REQUIRED; 是否保留原 Header 配置,取值及含义如下所示。
// * 0:保留;
// * 1:不保留。
BlockOriginal int32 `json:"BlockOriginal"`
// REQUIRED; 拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 配置是否启用,取值及含义如下所示。
// * true:启用;
// * false:禁用。
Enable bool `json:"Enable"`
// REQUIRED; 域名的 HTTP Header 具体字段配置。
HeaderDetailList []DescribeHTTPHeaderConfigResResultHeaderConfigListPropertiesItemsItem `json:"HeaderDetailList"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type DescribeHTTPHeaderConfigResResultHeaderConfigListPropertiesItemsItem ¶
type DescribeHTTPHeaderConfigResResultHeaderConfigListPropertiesItemsItem struct {
// REQUIRED; Header 配置中字段 Value 值的类型,取值及含义如下所示。
// * 0:常量;
// * 1:变量。
HeaderFieldType int32 `json:"HeaderFieldType"`
// REQUIRED; Header 配置中字段的 Key 值。
HeaderKey string `json:"HeaderKey"`
// REQUIRED; Header 配置中字段的 Value 值。
HeaderValue string `json:"HeaderValue"`
}
type DescribeIPAccessRule ¶
type DescribeIPAccessRule struct{}
type DescribeIPAccessRuleBody ¶
type DescribeIPAccessRuleBody struct {
// REQUIRED; 推流域名或拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要查询
// IP 访问限制的域名。
Domain string `json:"Domain"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要配置
// IP 访问限制的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type DescribeIPAccessRuleQuery ¶
type DescribeIPAccessRuleQuery struct{}
type DescribeIPAccessRuleReq ¶
type DescribeIPAccessRuleReq struct {
*DescribeIPAccessRuleQuery
*DescribeIPAccessRuleBody
}
type DescribeIPAccessRuleRes ¶
type DescribeIPAccessRuleRes struct {
// REQUIRED
ResponseMetadata DescribeIPAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeIPAccessRuleResResult `json:"Result"`
}
type DescribeIPAccessRuleResResponseMetadata ¶
type DescribeIPAccessRuleResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Error string `json:"Error"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
}
type DescribeIPAccessRuleResResult ¶
type DescribeIPAccessRuleResResult struct {
// REQUIRED; IP 访问限制规则列表。
AccessRuleLists []DescribeIPAccessRuleResResultAccessRuleListsItem `json:"AccessRuleLists"`
}
type DescribeIPAccessRuleResResultAccessRuleListsItem ¶
type DescribeIPAccessRuleResResultAccessRuleListsItem struct {
// 推/拉流域名。
Domain *string `json:"Domain,omitempty"`
// IP 访问限制规则。
IPAccessRule *DescribeIPAccessRuleResResultAccessRuleListsItemIPAccessRule `json:"IPAccessRule,omitempty"`
// 域名空间名称。
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeIPAccessRuleResResultAccessRuleListsItemIPAccessRule ¶
type DescribeIPAccessRuleResResultAccessRuleListsItemIPAccessRule struct {
// REQUIRED; 是否开启当前限制,取值及含义如下所示。
// * true: 开启;
// * false: 关闭。
Enable bool `json:"Enable"`
// REQUIRED; 名单中的 IP 信息。
IPList []string `json:"IPList"`
// REQUIRED; IP 访问限制的类型,取值及含义如下所示。
// * allow: 白名单;
// * deny: 黑名单。
Type string `json:"Type"`
}
DescribeIPAccessRuleResResultAccessRuleListsItemIPAccessRule - IP 访问限制规则。
type DescribeLatencyConfig ¶
type DescribeLatencyConfig struct{}
type DescribeLatencyConfigQuery ¶
type DescribeLatencyConfigQuery struct{}
type DescribeLatencyConfigReq ¶
type DescribeLatencyConfigReq struct {
*DescribeLatencyConfigQuery
*DescribeLatencyConfigBody
}
type DescribeLatencyConfigRes ¶
type DescribeLatencyConfigRes struct {
// REQUIRED
ResponseMetadata DescribeLatencyConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeLatencyConfigResResult `json:"Result,omitempty"`
}
type DescribeLatencyConfigResResponseMetadata ¶
type DescribeLatencyConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeLatencyConfigResResult ¶
type DescribeLatencyConfigResResult struct {
// REQUIRED
LatencyConfigList []DescribeLatencyConfigResResultLatencyConfigListItem `json:"LatencyConfigList"`
}
DescribeLatencyConfigResResult - 视请求的接口而定
type DescribeLatencyConfigResResultLatencyConfigListItem ¶
type DescribeLatencyConfigResResultLatencyConfigListItem struct {
// REQUIRED
CreateTime string `json:"CreateTime"`
// REQUIRED
Domain string `json:"Domain"`
// REQUIRED; 单位ms
GopCacheSize string `json:"GopCacheSize"`
// REQUIRED
UpdateTime string `json:"UpdateTime"`
// REQUIRED
Vhost string `json:"Vhost"`
}
type DescribeLicenseDRM ¶
type DescribeLicenseDRM struct{}
type DescribeLicenseDRMBody ¶
type DescribeLicenseDRMBody struct{}
type DescribeLicenseDRMQuery ¶
type DescribeLicenseDRMQuery struct {
// REQUIRED; 应用名称,取值与直播流地址的 AppName 字段相同,由大写小字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App" query:"App"`
// REQUIRED; DRM 加密的类型,取值及含义如下所示。
// * fp:FairPlay 加密;
// * wv:Widevine 加密;
// * pr:PlayReady 加密。
DRMType string `json:"DRMType" query:"DRMType"`
// REQUIRED; 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的拉流域名。
Domain string `json:"Domain" query:"Domain"`
// REQUIRED; 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
StreamName string `json:"StreamName" query:"StreamName"`
// REQUIRED; 拉取加密流时使用的拉流域名所在的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的拉流域名所属的域名空间。
Vhost string `json:"Vhost" query:"Vhost"`
}
type DescribeLicenseDRMReq ¶
type DescribeLicenseDRMReq struct {
*DescribeLicenseDRMQuery
*DescribeLicenseDRMBody
}
type DescribeLicenseDRMRes ¶
type DescribeLicenseDRMRes struct {
// REQUIRED
ResponseMetadata DescribeLicenseDRMResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type DescribeLicenseDRMResResponseMetadata ¶
type DescribeLicenseDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeLiveASRDurationData ¶ added in v1.0.28
type DescribeLiveASRDurationData struct{}
type DescribeLiveASRDurationDataBody ¶ added in v1.0.28
type DescribeLiveASRDurationDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// AI字幕原始语言,枚举值:ZH(中文),EN(英文), JA(日文), KO(韩文)
ASRSourceType *string `json:"ASRSourceType,omitempty"`
// AI字幕转换的语言类型,ASRTargetTypeList和ASRSourceType必须同时指定, 枚举值:ZH(中文),EN(英文), JA(日文), KO(韩文)
ASRTargetTypeList []*string `json:"ASRTargetTypeList,omitempty"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 300 (default): 5 minutes. When aggregated in 5-minute intervals, the maximum time span for a single query is 31 days,
// and for historical queries, the maximum time range is 366 days.
// * 3600: 1 hour. When aggregated in 1-hour intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
// * 86400: 1 day. When aggregated in 1-day intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 应用列表,缺省表示该用户所有的app
AppList []*string `json:"AppList,omitempty"`
// 域名列表,缺省情况表示该用户的所有域名
DomainList []*string `json:"DomainList,omitempty"`
}
type DescribeLiveASRDurationDataQuery ¶ added in v1.0.28
type DescribeLiveASRDurationDataQuery struct{}
type DescribeLiveASRDurationDataReq ¶ added in v1.0.28
type DescribeLiveASRDurationDataReq struct {
*DescribeLiveASRDurationDataQuery
*DescribeLiveASRDurationDataBody
}
type DescribeLiveASRDurationDataRes ¶ added in v1.0.28
type DescribeLiveASRDurationDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveASRDurationDataResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeLiveASRDurationDataResResult `json:"Result,omitempty"`
}
type DescribeLiveASRDurationDataResResponseMetadata ¶ added in v1.0.28
type DescribeLiveASRDurationDataResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeLiveASRDurationDataResResult ¶ added in v1.0.28
type DescribeLiveASRDurationDataResResult struct {
// REQUIRED; 每个时间点对应的转换时长
ASRDurationData []DescribeLiveASRDurationDataResResultASRDurationDataItem `json:"ASRDurationData"`
// REQUIRED; 每个字幕转换类型在每个时间点的时长
ASRDurationDetailData []DescribeLiveASRDurationDataResResultASRDurationDetailDataItem `json:"ASRDurationDetailData"`
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; AI字幕总时长总量,unit is minute
Duration float32 `json:"Duration"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// AI字幕原始语言
ASRSourceType *string `json:"ASRSourceType,omitempty"`
// AI字幕转换的语言类型
ASRTargetTypeList []*string `json:"ASRTargetTypeList,omitempty"`
// 应用列表,缺省表示该用户所有的app
AppList []*string `json:"AppList,omitempty"`
// 域名列表,缺省情况表示该用户的所有域名
DomainList []*string `json:"DomainList,omitempty"`
}
DescribeLiveASRDurationDataResResult - 视请求的接口而定
type DescribeLiveASRDurationDataResResultASRDurationDataItem ¶ added in v1.0.28
type DescribeLiveASRDurationDataResResultASRDurationDataItem struct {
// REQUIRED; AI字幕时长,单位为分钟
Duration float32 `json:"Duration"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLiveASRDurationDataResResultASRDurationDetailDataItem ¶ added in v1.0.28
type DescribeLiveASRDurationDataResResultASRDurationDetailDataItem struct {
// REQUIRED; 每个时间点对应的时长
ASRDurationData []Components17Ohct5SchemasDescribeliveasrdurationdataresPropertiesResultPropertiesAsrdurationdetaildataItemsPropertiesAsrdurationdataItems `json:"ASRDurationData"`
// REQUIRED; AI字幕原始语言
ASRSourceType string `json:"ASRSourceType"`
// REQUIRED; AI字幕转换的语言类型
ASRTargetTypeList []string `json:"ASRTargetTypeList"`
}
type DescribeLiveBandwidthData ¶
type DescribeLiveBandwidthData struct{}
type DescribeLiveBandwidthDataBody ¶
type DescribeLiveBandwidthDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 300 (default): 5 minutes. When aggregated in 5-minute intervals, the maximum time span for a single query is 31 days,
// and for historical queries, the maximum time range is 366 days.
// * 3600: 1 hour. When aggregated in 1-hour intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
// * 86400: 1 day. When aggregated in 1-day intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议。 :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain
// 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的带宽用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLiveBandwidthDataBodyRegionListItem `json:"RegionList,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLiveBandwidthDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveBandwidthDataBodyRegionListItem ¶
type DescribeLiveBandwidthDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveBandwidthDataBodyUserRegionListItem ¶
type DescribeLiveBandwidthDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveBandwidthDataQuery ¶
type DescribeLiveBandwidthDataQuery struct{}
type DescribeLiveBandwidthDataReq ¶
type DescribeLiveBandwidthDataReq struct {
*DescribeLiveBandwidthDataQuery
*DescribeLiveBandwidthDataBody
}
type DescribeLiveBandwidthDataRes ¶
type DescribeLiveBandwidthDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveBandwidthDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveBandwidthDataResResult `json:"Result"`
}
type DescribeLiveBandwidthDataResResult ¶
type DescribeLiveBandwidthDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 所有时间粒度的数据。
BandwidthDataList []DescribeLiveBandwidthDataResResultBandwidthDataListItem `json:"BandwidthDataList"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 查询时间范围内的下行峰值带宽,单位为 Mbps。
PeakDownBandwidth float32 `json:"PeakDownBandwidth"`
// REQUIRED; 查询时间范围内的上行峰值带宽,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// 按维度拆分后的数据。 :::tip 当配置了数据拆分的维度时,对应的维度参数传入多个值才会返回按维度拆分的数据。 :::
BandwidthDetailDataList []*DescribeLiveBandwidthDataResResultBandwidthDetailDataListItem `json:"BandwidthDetailDataList,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveBandwidthDataResResultRegionListItem `json:"RegionList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveBandwidthDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveBandwidthDataResResultBandwidthDataListItem ¶
type DescribeLiveBandwidthDataResResultBandwidthDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的下行峰值带宽,单位为 Mbps。
DownBandwidth float32 `json:"DownBandwidth"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内的上行峰值带宽,单位为 Mbps。
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLiveBandwidthDataResResultBandwidthDetailDataListItem ¶
type DescribeLiveBandwidthDataResResultBandwidthDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
BandwidthDataList []DescribeLiveBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem `json:"BandwidthDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的下行峰值带宽,单位为 Mbps。
PeakDownBandwidth float32 `json:"PeakDownBandwidth"`
// REQUIRED; 按维度进行数据拆分后,当前维度的上行峰值带宽,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按推拉流协议维度进行数据拆分时的协议信息。
Protocol *string `json:"Protocol,omitempty"`
}
type DescribeLiveBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem ¶
type DescribeLiveBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem struct {
// REQUIRED; 下行带宽,单位为 Mbps
DownBandwidth float32 `json:"DownBandwidth"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 上行带宽,单位为 Mbps
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLiveBandwidthDataResResultRegionListItem ¶
type DescribeLiveBandwidthDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveBandwidthDataResResultUserRegionListItem ¶
type DescribeLiveBandwidthDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveBatchPushStreamMetrics ¶
type DescribeLiveBatchPushStreamMetrics struct{}
type DescribeLiveBatchPushStreamMetricsBody ¶
type DescribeLiveBatchPushStreamMetricsBody struct {
// REQUIRED; 推流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的推流域名。
Domain string `json:"Domain"`
// REQUIRED; 请控制查询的数据量,如果查询速度较慢请缩短查询时间范围
EndTime string `json:"EndTime"`
// REQUIRED; 查询的开始时间,RFC3339 格式的时间戳,精度为秒。
// :::tip 单次查询最大时间跨度为 1 天,历史查询最大时间范围为 366 天。 :::
StartTime string `json:"StartTime"`
// 指标聚合算法,支持max:峰值聚合,avg:平均值,默认max
AggType *string `json:"AggType,omitempty"`
// 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
// * 5:5 秒;
// * 30:30 秒;
// * 60:(默认值)1 分钟。
Aggregation *int32 `json:"Aggregation,omitempty"`
// 应用名称,取值与直播流地址中的 AppName 字段取值相同,查询流粒度数据时必传,且需同时传入 Stream。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30
// 个字符。 :::tip 查询流粒度的监控数据时,需同时指定 App 和 Stream 来指定直播流。 :::
App *string `json:"App,omitempty"`
// 流名称,预置与直播流地址中的 StreamName 字段取值相同,查询流粒度数据时必传,且需同时传入 Stream。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到
// 100 个字符。 :::tip 查询流粒度的监控数据时,需同时指定 App 和 Stream 来指定直播流。 :::
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveBatchPushStreamMetricsQuery ¶
type DescribeLiveBatchPushStreamMetricsQuery struct{}
type DescribeLiveBatchPushStreamMetricsReq ¶
type DescribeLiveBatchPushStreamMetricsReq struct {
*DescribeLiveBatchPushStreamMetricsQuery
*DescribeLiveBatchPushStreamMetricsBody
}
type DescribeLiveBatchPushStreamMetricsRes ¶
type DescribeLiveBatchPushStreamMetricsRes struct {
// REQUIRED
ResponseMetadata DescribeLiveBatchPushStreamMetricsResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveBatchPushStreamMetricsResResult `json:"Result"`
}
type DescribeLiveBatchPushStreamMetricsResResult ¶
type DescribeLiveBatchPushStreamMetricsResResult struct {
// REQUIRED; 数据聚合的时间粒度,单位为秒。
// * 5:5 秒;
// * 30:30 秒;
// * 60:1 分钟。
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 推流域名。
Domain string `json:"Domain"`
// REQUIRED; 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
EndTime string `json:"EndTime"`
// REQUIRED; 查询的开始时间,RFC3339 格式的时间戳,精度为秒。
StartTime string `json:"StartTime"`
// REQUIRED; 直推流的信息,包含域名、应用名称、流名称和监控数据。
StreamMetricList []DescribeLiveBatchPushStreamMetricsResResultStreamMetricListItem `json:"StreamMetricList"`
// 数据聚合时间粒度内,动态指标的聚合算法,取值及含义如下所示。
// * max:(默认值)计算聚合时间粒度内的最大值;
// * avg:计算聚合时间粒度内的平均值。
AggType *string `json:"AggType,omitempty"`
// 应用名称。
App *string `json:"App,omitempty"`
// 流名称。
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListItem ¶
type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 推流域名。
Domain string `json:"Domain"`
// REQUIRED; 按指定时间粒度聚合的监控数据。
MetricList []DescribeLiveBatchPushStreamMetricsResResultStreamMetricListPropertiesItemsItem `json:"MetricList"`
// REQUIRED; 标记一路推流的唯一id
SessionID string `json:"SessionID"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
}
type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListPropertiesItemsItem ¶
type DescribeLiveBatchPushStreamMetricsResResultStreamMetricListPropertiesItemsItem struct {
// REQUIRED; 音频编码格式。 Eg. ACC
ACodec string `json:"ACodec"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的音频码率,单位为 kbps。
AudioBitrate float32 `json:"AudioBitrate"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的相邻音频帧显示时间戳差值,单位为毫秒。
AudioFrameGap int32 `json:"AudioFrameGap"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的音频帧率(每秒传输的音频数据包个数)。
AudioFramerate float32 `json:"AudioFramerate"`
// REQUIRED; 数据聚合时间粒度内,最后一个音频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
AudioPts int32 `json:"AudioPts"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的视频码率,单位为 kbps。
Bitrate float32 `json:"Bitrate"`
// REQUIRED; 客户端ip
ClientIP string `json:"ClientIp"`
// REQUIRED; 收到首帧的时间,,单位毫秒
FirstFrameTime int32 `json:"FirstFrameTime"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的视频帧率,单位为 fps。
Framerate float32 `json:"Framerate"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的音视频帧显示时间戳差值,即所有 AudioPts 与 VideoPts 差值的最大值,单位为毫秒。
PtsDelta int32 `json:"PtsDelta"`
// REQUIRED; 分辨率
Resolution string `json:"Resolution"`
// REQUIRED; 服务端ip
ServerIP string `json:"ServerIp"`
// REQUIRED; 推流开始时间,单位毫秒
StreamBeginTime int64 `json:"StreamBeginTime"`
// REQUIRED; 数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的时间戳,精度为秒。
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 视频编码格式。 Eg. H264
VCodec string `json:"VCodec"`
// REQUIRED; 数据聚合时间粒度内,按聚合算法得出的相邻视频帧显示时间戳差值,单位为毫秒。
VideoFrameGap int32 `json:"VideoFrameGap"`
// REQUIRED; 数据聚合时间粒度内,最后一个视频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
VideoPts int32 `json:"VideoPts"`
}
type DescribeLiveISPData ¶
type DescribeLiveISPData struct{}
type DescribeLiveISPDataBody ¶
type DescribeLiveISPDataBody struct{}
type DescribeLiveISPDataQuery ¶
type DescribeLiveISPDataQuery struct{}
type DescribeLiveISPDataReq ¶
type DescribeLiveISPDataReq struct {
*DescribeLiveISPDataQuery
*DescribeLiveISPDataBody
}
type DescribeLiveISPDataRes ¶
type DescribeLiveISPDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveISPDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveISPDataResResult `json:"Result"`
}
type DescribeLiveISPDataResResult ¶
type DescribeLiveISPDataResResult struct {
// REQUIRED; 运营商信息,视频直播提供的网络运营商标识,支持的运营商如下所示。
// * unicom:联通;
// * railcom:铁通;
// * telecom:电信;
// * mobile:移动;
// * cernet:教育网;
// * tianwei:天威;
// * alibaba:阿里巴巴;
// * tencent:腾讯;
// * drpeng:鹏博士;
// * btvn:广电;
// * huashu:华数;
// * other:其他。
ISPList []DescribeLiveISPDataResResultISPListItem `json:"ISPList"`
}
type DescribeLiveLogData ¶
type DescribeLiveLogData struct{}
type DescribeLiveLogDataBody ¶
type DescribeLiveLogDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// REQUIRED; 日志类型,支持的类型如下所示。
// * pull:拉流日志;
// * push:推流日志;
// * source:回源日志;
// * relay:拉流转推日志。
Type string `json:"Type"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的日志文件信息。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。 :::tip
// 日志类型为拉流转推日志(Type 取值为 relay)时,该参数无效。 :::
DomainList []*string `json:"DomainList,omitempty"`
// 查询数据的页码,默认为 1,表示查询第一页的数据。
PageNum *int32 `json:"PageNum,omitempty"`
// 每页显示的数据条数,默认为 20,最大值为 1000。
PageSize *int32 `json:"PageSize,omitempty"`
}
type DescribeLiveLogDataQuery ¶
type DescribeLiveLogDataQuery struct{}
type DescribeLiveLogDataReq ¶
type DescribeLiveLogDataReq struct {
*DescribeLiveLogDataQuery
*DescribeLiveLogDataBody
}
type DescribeLiveLogDataRes ¶
type DescribeLiveLogDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveLogDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveLogDataResResult `json:"Result"`
}
type DescribeLiveLogDataResResult ¶
type DescribeLiveLogDataResResult struct {
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 日志文件的信息列表。
LogInfoList []DescribeLiveLogDataResResultLogInfoListItem `json:"LogInfoList"`
// REQUIRED; 数据分页信息。
Pagination DescribeLiveLogDataResResultPagination `json:"Pagination"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 日志类型,类型说明如下所示。
// * pull:拉流日志
// * push:推流日志
// * source:回源日志
// * relay:拉流转推日志
Type string `json:"Type"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
}
type DescribeLiveLogDataResResultLogInfoListItem ¶
type DescribeLiveLogDataResResultLogInfoListItem struct {
// REQUIRED; 日志文件对应的小时区间,RFC3339 格式的时间戳,精度为秒。
DateTime string `json:"DateTime"`
// REQUIRED; 日志文件下载链接。
DownloadURL string `json:"DownloadUrl"`
// REQUIRED; 日志文件名称,日志文件命名规则如下。
// * 与域名相关时:加速域名年月日时间开始时间结束文件拆分序号。例如,push.example.com_2023_08_11_000000_010000_0.gz;
// * 与域名无关时:年月日时间开始时间结束_文件拆分序号。例如,2023_08_11_000000_010000_0.gz; :::tip 如果某个小时内,当前事件产生的日志大于 150 万条,则会生成为多个日志文件,用文件名最后的序号标注日志文件顺序,例如,2023_08_11_000000_010000_0.gz、2023_08_11_000000_010000_1.gz。
// :::
LogName string `json:"LogName"`
// REQUIRED; 日志文件大小,单位为 byte。
LogSize int32 `json:"LogSize"`
// 域名。 :::tip 查询拉流转推日志(Type 取值为 relay)时,该字段为空。 :::
Domain *string `json:"Domain,omitempty"`
}
type DescribeLiveLogDataResResultPagination ¶
type DescribeLiveLogDataResResultPagination struct {
// REQUIRED; 当前所在分页的页码。
PageNum int32 `json:"PageNum"`
// REQUIRED; 每页显示的数据条数。
PageSize int32 `json:"PageSize"`
// REQUIRED; 查询结果的数据总条数。
TotalCount int32 `json:"TotalCount"`
}
DescribeLiveLogDataResResultPagination - 数据分页信息。
type DescribeLiveMetricBandwidthData ¶
type DescribeLiveMetricBandwidthData struct{}
type DescribeLiveMetricBandwidthDataBody ¶
type DescribeLiveMetricBandwidthDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * Protocol:推拉流协议;
// * ISP:运营商。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的带宽监控数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLiveMetricBandwidthDataBodyRegionListItem `json:"RegionList,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLiveMetricBandwidthDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveMetricBandwidthDataBodyRegionListItem ¶
type DescribeLiveMetricBandwidthDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricBandwidthDataBodyUserRegionListItem ¶
type DescribeLiveMetricBandwidthDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricBandwidthDataQuery ¶
type DescribeLiveMetricBandwidthDataQuery struct{}
type DescribeLiveMetricBandwidthDataReq ¶
type DescribeLiveMetricBandwidthDataReq struct {
*DescribeLiveMetricBandwidthDataQuery
*DescribeLiveMetricBandwidthDataBody
}
type DescribeLiveMetricBandwidthDataRes ¶
type DescribeLiveMetricBandwidthDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveMetricBandwidthDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveMetricBandwidthDataResResult `json:"Result"`
}
type DescribeLiveMetricBandwidthDataResResult ¶
type DescribeLiveMetricBandwidthDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 所有时间粒度的数据。
BandwidthDataList []DescribeLiveMetricBandwidthDataResResultBandwidthDataListItem `json:"BandwidthDataList"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 查询时间范围内的下行峰值,单位为 Mbps。
PeakDownBandwidth float32 `json:"PeakDownBandwidth"`
// REQUIRED; 查询时间范围内的上行峰值,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 按维度拆分后的数据。
BandwidthDetailDataList []*DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListItem `json:"BandwidthDetailDataList,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * Protocol:推拉流协议;
// * ISP:运营商。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveMetricBandwidthDataResResultRegionListItem `json:"RegionList,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveMetricBandwidthDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveMetricBandwidthDataResResultBandwidthDataListItem ¶
type DescribeLiveMetricBandwidthDataResResultBandwidthDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的下行峰值带宽,单位为 Mbps。
DownBandwidth float32 `json:"DownBandwidth"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内的上行峰值带宽,单位为 Mbps。
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListItem ¶
type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
BandwidthDataList []DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem `json:"BandwidthDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的下行峰值带宽,单位为 Mbps。
PeakDownBandwidth float32 `json:"PeakDownBandwidth"`
// REQUIRED; 按维度进行数据拆分后,当前维度的上行峰值带宽,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按推拉流协议维度进行数据拆分时的协议信息。
Protocol *string `json:"Protocol,omitempty"`
}
type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem ¶
type DescribeLiveMetricBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem struct {
// REQUIRED; 下行带宽,单位为 Mbps
DownBandwidth float32 `json:"DownBandwidth"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 上行带宽,单位为 Mbps
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLiveMetricBandwidthDataResResultRegionListItem ¶
type DescribeLiveMetricBandwidthDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricBandwidthDataResResultUserRegionListItem ¶
type DescribeLiveMetricBandwidthDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricTrafficData ¶
type DescribeLiveMetricTrafficData struct{}
type DescribeLiveMetricTrafficDataBody ¶
type DescribeLiveMetricTrafficDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * Protocol:推拉流协议;
// * ISP:运营商。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的流量监控数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLiveMetricTrafficDataBodyRegionListItem `json:"RegionList,omitempty"`
// 指定查询的流量数据为闲时或忙时,缺省情况下为查询全部数据,支持的取值如下。
// * busy:忙时;
// * free:闲时。
Stage *string `json:"Stage,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLiveMetricTrafficDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveMetricTrafficDataBodyRegionListItem ¶
type DescribeLiveMetricTrafficDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricTrafficDataBodyUserRegionListItem ¶
type DescribeLiveMetricTrafficDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricTrafficDataQuery ¶
type DescribeLiveMetricTrafficDataQuery struct{}
type DescribeLiveMetricTrafficDataReq ¶
type DescribeLiveMetricTrafficDataReq struct {
*DescribeLiveMetricTrafficDataQuery
*DescribeLiveMetricTrafficDataBody
}
type DescribeLiveMetricTrafficDataRes ¶
type DescribeLiveMetricTrafficDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveMetricTrafficDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveMetricTrafficDataResResult `json:"Result"`
}
type DescribeLiveMetricTrafficDataResResult ¶
type DescribeLiveMetricTrafficDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 查询时间范围内的下行总流量,单位为 GB。
TotalDownTraffic float32 `json:"TotalDownTraffic"`
// REQUIRED; 查询时间范围内的上行总流量,单位为 GB。
TotalUpTraffic float32 `json:"TotalUpTraffic"`
// REQUIRED; 所有时间粒度的数据。
TrafficDataList []DescribeLiveMetricTrafficDataResResultTrafficDataListItem `json:"TrafficDataList"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * Protocol:推拉流协议;
// * ISP:运营商。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveMetricTrafficDataResResultRegionListItem `json:"RegionList,omitempty"`
// 流量数据为闲时或忙时,取值说明如下。
// * busy:忙时;
// * free:闲时。
Stage *string `json:"Stage,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
// 按维度拆分后的数据。 :::tip 配置数据拆分维度时,对应的维度参数传入多个值时会返回按维度进行拆分的数据;对应的维度只传入一个值时不返回按此维度进行拆分的数据。 :::
TrafficDetailDataList []*DescribeLiveMetricTrafficDataResResultTrafficDetailDataListItem `json:"TrafficDetailDataList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveMetricTrafficDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveMetricTrafficDataResResultRegionListItem ¶
type DescribeLiveMetricTrafficDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveMetricTrafficDataResResultTrafficDataListItem ¶
type DescribeLiveMetricTrafficDataResResultTrafficDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内产生的总下行流量,单位 GB。
DownTraffic float32 `json:"DownTraffic"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内产生的总上行流量,单位 GB。
UpTraffic float32 `json:"UpTraffic"`
}
type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListItem ¶
type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度的下行总流量,单位为 GB。
TotalDownTraffic float32 `json:"TotalDownTraffic"`
// REQUIRED; 按维度进行数据拆分后,当前维度的上行总流量,单位为 GB。
TotalUpTraffic float32 `json:"TotalUpTraffic"`
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
TrafficDataList []DescribeLiveMetricTrafficDataResResultTrafficDetailDataListPropertiesItemsItem `json:"TrafficDataList"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按推拉流协议维度进行数据拆分时的协议信息。
Protocol *string `json:"Protocol,omitempty"`
}
type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListPropertiesItemsItem ¶
type DescribeLiveMetricTrafficDataResResultTrafficDetailDataListPropertiesItemsItem struct {
// REQUIRED; 下行流量,单位 GB
DownTraffic float32 `json:"DownTraffic"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 上行流量,单位 GB
UpTraffic float32 `json:"UpTraffic"`
}
type DescribeLiveMetricTrafficDataResResultUserRegionListItem ¶
type DescribeLiveMetricTrafficDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveP95PeakBandwidthData ¶
type DescribeLiveP95PeakBandwidthData struct{}
type DescribeLiveP95PeakBandwidthDataBody ¶
type DescribeLiveP95PeakBandwidthDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// 数据聚合的时间粒度,单位为秒,当前接口默认且仅支持按 300 秒进行数据拆分。
Aggregation *int32 `json:"Aggregation,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的 95 峰值带宽用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Push-pull streaming protocol. By default, all protocol types are indicated. Supported protocols are as follows.
// * HTTP-FLV: A push-pull streaming protocol based on the HTTP protocol, using the FLV format for video transmission.
// * HTTP-HLS: A push-pull streaming protocol based on the HTTP protocol, using the TS format for video transmission.
// * RTMP: Real-Time Messaging Protocol for real-time message transmission.
// * RTM: Real-Time Media protocol for ultra-low latency live streaming.
// * SRT: Secure Reliable Transport protocol for secure and reliable streaming.
// * QUIC: Quick UDP Internet Connections, a new low-latency internet transmission protocol based on UDP.
// * CMAF: Common Media Application Format, a versatile streaming protocol.
// :::tip If querying the QUIC protocol, other protocols cannot be queried simultaneously. :::
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLiveP95PeakBandwidthDataBodyRegionListItem `json:"RegionList,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveP95PeakBandwidthDataBodyRegionListItem ¶
type DescribeLiveP95PeakBandwidthDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem ¶
type DescribeLiveP95PeakBandwidthDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveP95PeakBandwidthDataQuery ¶
type DescribeLiveP95PeakBandwidthDataQuery struct{}
type DescribeLiveP95PeakBandwidthDataReq ¶
type DescribeLiveP95PeakBandwidthDataReq struct {
*DescribeLiveP95PeakBandwidthDataQuery
*DescribeLiveP95PeakBandwidthDataBody
}
type DescribeLiveP95PeakBandwidthDataRes ¶
type DescribeLiveP95PeakBandwidthDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveP95PeakBandwidthDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveP95PeakBandwidthDataResResult `json:"Result"`
}
type DescribeLiveP95PeakBandwidthDataResResult ¶
type DescribeLiveP95PeakBandwidthDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 时间范围内的上下行 95 峰值带宽总和。 :::tip 如果请求时,Regionlist中传入多个 region,则返回这些 region 的上下行带宽 95 峰值总和。 :::
P95PeakBandwidth float32 `json:"P95PeakBandwidth"`
// REQUIRED; 95 峰值带宽的时间戳,RFC3339 格式的时间戳,精度为秒。
P95PeakTimestamp string `json:"P95PeakTimestamp"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Push-pull streaming protocol. By default, all protocol types are indicated. Supported protocols are as follows.
// * HTTP-FLV: A push-pull streaming protocol based on the HTTP protocol, using the FLV format for video transmission.
// * HTTP-HLS: A push-pull streaming protocol based on the HTTP protocol, using the TS format for video transmission.
// * RTMP: Real-Time Messaging Protocol for real-time message transmission.
// * RTM: Real-Time Media protocol for ultra-low latency live streaming.
// * SRT: Secure Reliable Transport protocol for secure and reliable streaming.
// * QUIC: Quick UDP Internet Connections, a new low-latency internet transmission protocol based on UDP.
// * CMAF: Common Media Application Format, a versatile streaming protocol.
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveP95PeakBandwidthDataResResultRegionListItem `json:"RegionList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveP95PeakBandwidthDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveP95PeakBandwidthDataResResultRegionListItem ¶
type DescribeLiveP95PeakBandwidthDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveP95PeakBandwidthDataResResultUserRegionListItem ¶
type DescribeLiveP95PeakBandwidthDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLivePlayStatusCodeData ¶
type DescribeLivePlayStatusCodeData struct{}
type DescribeLivePlayStatusCodeDataBody ¶
type DescribeLivePlayStatusCodeDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * ISP:运营商。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空时表示查询所有域名下产生的请求状态码占比数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询请求状态码占比数据的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLivePlayStatusCodeDataBodyRegionListItem `json:"RegionList,omitempty"`
// 请求类型,取值及含义如下所示。
// * Access:(默认值)推流请求和拉流请求;
// * Source:回源请求。
Type *string `json:"Type,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLivePlayStatusCodeDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLivePlayStatusCodeDataBodyRegionListItem ¶
type DescribeLivePlayStatusCodeDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLivePlayStatusCodeDataBodyUserRegionListItem ¶
type DescribeLivePlayStatusCodeDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLivePlayStatusCodeDataQuery ¶
type DescribeLivePlayStatusCodeDataQuery struct{}
type DescribeLivePlayStatusCodeDataReq ¶
type DescribeLivePlayStatusCodeDataReq struct {
*DescribeLivePlayStatusCodeDataQuery
*DescribeLivePlayStatusCodeDataBody
}
type DescribeLivePlayStatusCodeDataRes ¶
type DescribeLivePlayStatusCodeDataRes struct {
// REQUIRED
ResponseMetadata DescribeLivePlayStatusCodeDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLivePlayStatusCodeDataResResult `json:"Result"`
}
type DescribeLivePlayStatusCodeDataResResult ¶
type DescribeLivePlayStatusCodeDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 所有时间粒度的数据。
StatusDataList []DescribeLivePlayStatusCodeDataResResultStatusDataListItem `json:"StatusDataList"`
// REQUIRED; 当前查询条件下的状态码占比数据。
StatusSummaryDataList []DescribeLivePlayStatusCodeDataResResultStatusSummaryDataListItem `json:"StatusSummaryDataList"`
// REQUIRED; 请求类型,取值及含义如下所示。
// * Access:推流请求和拉流请求;
// * Source:回源请求。
Type string `json:"Type"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLivePlayStatusCodeDataResResultRegionListItem `json:"RegionList,omitempty"`
// 按维度拆分后的数据。
StatusDetailDataList []*DescribeLivePlayStatusCodeDataResResultStatusDetailDataListItem `json:"StatusDetailDataList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLivePlayStatusCodeDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLivePlayStatusCodeDataResResultRegionListItem ¶
type DescribeLivePlayStatusCodeDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLivePlayStatusCodeDataResResultStatusDataListItem ¶
type DescribeLivePlayStatusCodeDataResResultStatusDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的状态码详细数据。
StatusSummaryDataList []DescribeLivePlayStatusCodeDataResResultStatusDataListPropertiesItemsItem `json:"StatusSummaryDataList"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListItem ¶
type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListItem struct {
// 拉流域名。
Domain *string `json:"Domain,omitempty"`
// 运营商。
ISP *string `json:"ISP,omitempty"`
// 每个时间点的粒度数据。
StatusDataList []*DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsItem `json:"StatusDataList,omitempty"`
}
type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsItem ¶
type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsItem struct {
// REQUIRED; 按状态码区分的数据列表。
StatusSummaryDataList []DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsStatusSummaryDataListItem `json:"StatusSummaryDataList"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLivePlayStatusCodeDataResResultStatusDetailDataListPropertiesItemsStatusSummaryDataListItem ¶
type DescribeLivePlayStatusCodeDataResResultUserRegionListItem ¶
type DescribeLivePlayStatusCodeDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLivePullToPushBandwidthData ¶
type DescribeLivePullToPushBandwidthData struct{}
type DescribeLivePullToPushBandwidthDataBody ¶
type DescribeLivePullToPushBandwidthDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 300 (default): 5 minutes. When aggregated in 5-minute intervals, the maximum time span for a single query is 31 days,
// and for historical queries, the maximum time range is 366 days.
// * 3600: 1 hour. When aggregated in 1-hour intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
// * 86400: 1 day. When aggregated in 1-day intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 支持域名拆分
DetailField []*string `json:"DetailField,omitempty"`
// 拉流转推任务群组列表,默认为空,表示查询所有拉流转推任务群组的带宽用量。
GroupList []*string `json:"GroupList,omitempty"`
}
type DescribeLivePullToPushBandwidthDataQuery ¶
type DescribeLivePullToPushBandwidthDataQuery struct{}
type DescribeLivePullToPushBandwidthDataReq ¶
type DescribeLivePullToPushBandwidthDataReq struct {
*DescribeLivePullToPushBandwidthDataQuery
*DescribeLivePullToPushBandwidthDataBody
}
type DescribeLivePullToPushBandwidthDataRes ¶
type DescribeLivePullToPushBandwidthDataRes struct {
// REQUIRED
ResponseMetadata DescribeLivePullToPushBandwidthDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLivePullToPushBandwidthDataResResult `json:"Result,omitempty"`
}
type DescribeLivePullToPushBandwidthDataResResponseMetadata ¶
type DescribeLivePullToPushBandwidthDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLivePullToPushBandwidthDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLivePullToPushBandwidthDataResResult ¶
type DescribeLivePullToPushBandwidthDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 所有时间粒度的数据。
BandwidthDataList []DescribeLivePullToPushBandwidthDataResResultBandwidthDataListItem `json:"BandwidthDataList"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 当前查询条件下的拉流转推峰值带宽,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// 按维度拆分后的数据。 :::tip 当配置了数据拆分的维度时,对应的维度参数传入多个值才会返回按维度拆分的数据。 :::
BandwidthDetailDataList []*DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListItem `json:"BandwidthDetailDataList,omitempty"`
// 数据拆分的维度。
DetailField []*string `json:"DetailField,omitempty"`
// 拉流转推任务群组列表。
GroupList []*string `json:"GroupList,omitempty"`
}
type DescribeLivePullToPushBandwidthDataResResultBandwidthDataListItem ¶
type DescribeLivePullToPushBandwidthDataResResultBandwidthDataListItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内的拉流转推峰值带宽,单位为 Mbps。
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListItem ¶
type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
BandwidthDataList []DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem `json:"BandwidthDataList"`
// REQUIRED; 查询时间范围内的维度下的拉流转推峰值带宽,单位为 Mbps。
PeakUpBandwidth float32 `json:"PeakUpBandwidth"`
// 按推流地址类型维度进行数据拆分时的地址类型信息。
DstAddrType *string `json:"DstAddrType,omitempty"`
// 按任务群组维度进行数据拆分时的群组信息。
Group *string `json:"Group,omitempty"`
}
type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem ¶
type DescribeLivePullToPushBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 转推带宽,单位为 Mbps
UpBandwidth float32 `json:"UpBandwidth"`
}
type DescribeLivePullToPushData ¶
type DescribeLivePullToPushData struct{}
type DescribeLivePullToPushDataBody ¶
type DescribeLivePullToPushDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
// * 60:1 分钟。时间粒度为 1 分钟时,单次查询最大时间跨度为 1 天,历史查询时间范围为 366 天;
// * 3600:1 小时。时间粒度为 1 小时时,单次查询时间跨度为 93 天,历史查询时间范围为 366 天;
// * 86400:(默认值)1 天。时间粒度为 1 天时,单次查询最大时间跨度为 93 天,历史查询时间范围为 366 天。
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 支持群组拆分
DetailField []*string `json:"DetailField,omitempty"`
// 群组
GroupList []*string `json:"GroupList,omitempty"`
// The Stream Name must correspond to the value of the StreamName field in the live stream URL. It can include uppercase and
// lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 100 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters must be provided. :::
Stream *string `json:"Stream,omitempty"`
}
type DescribeLivePullToPushDataQuery ¶
type DescribeLivePullToPushDataQuery struct{}
type DescribeLivePullToPushDataReq ¶
type DescribeLivePullToPushDataReq struct {
*DescribeLivePullToPushDataQuery
*DescribeLivePullToPushDataBody
}
type DescribeLivePullToPushDataRes ¶
type DescribeLivePullToPushDataRes struct {
// REQUIRED
ResponseMetadata DescribeLivePullToPushDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLivePullToPushDataResResult `json:"Result,omitempty"`
}
type DescribeLivePullToPushDataResResponseMetadata ¶
type DescribeLivePullToPushDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLivePullToPushDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLivePullToPushDataResResult ¶
type DescribeLivePullToPushDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 所有时间粒度的数据。
PullToPushDataList []DescribeLivePullToPushDataResResultPullToPushDataListItem `json:"PullToPushDataList"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 当前查询条件下的拉流转推总时长,单位为分钟。
TotalDuration float32 `json:"TotalDuration"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 数据拆分的维度,当前接口仅支持按 Group 即拉流转推任务群组维度进行数据拆分。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 拉流转推任务群组。
GroupList []*string `json:"GroupList,omitempty"`
// 按维度拆分后的数据。
PullToPushDetailDataList []*DescribeLivePullToPushDataResResultPullToPushDetailDataListItem `json:"PullToPushDetailDataList,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
}
type DescribeLivePullToPushDataResResultPullToPushDataListItem ¶
type DescribeLivePullToPushDataResResultPullToPushDataListItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内的拉流转推总时长,单位为分钟。
Value float32 `json:"Value"`
}
type DescribeLivePullToPushDataResResultPullToPushDetailDataListItem ¶
type DescribeLivePullToPushDataResResultPullToPushDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
PullToPushDataList []DescribeLivePullToPushDataResResultPullToPushDetailDataListPropertiesItemsItem `json:"PullToPushDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的拉流转推总时长,单位分钟。
TotalDuration float32 `json:"TotalDuration"`
// 按任务群组维度进行数据拆分时的群组信息。
Group *string `json:"Group,omitempty"`
}
type DescribeLivePullToPushDataResResultPullToPushDetailDataListPropertiesItemsItem ¶
type DescribeLivePullToPushDataResResultPullToPushDetailDataListPropertiesItemsItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 该时间片内的拉流转推总时长,单位分钟,保留小数点后 2 位
Value float32 `json:"Value"`
}
type DescribeLivePushStreamInfoData ¶ added in v1.0.28
type DescribeLivePushStreamInfoData struct{}
type DescribeLivePushStreamInfoDataBody ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataBody struct {
// REQUIRED; 查询的结束时间。只能查询93d以内的数据
EndTime string `json:"EndTime"`
// REQUIRED; 查询的起始时间。
StartTime string `json:"StartTime"`
// 应用名称
App *string `json:"App,omitempty"`
// 域名列表,缺省情况表示该用户的所有域名
DomainList []*string `json:"DomainList,omitempty"`
// 分页页数,默认1
PageNum *int32 `json:"PageNum,omitempty"`
// 每页大小, 默认20
PageSize *int32 `json:"PageSize,omitempty"`
// 直播流名称
Stream *string `json:"Stream,omitempty"`
}
type DescribeLivePushStreamInfoDataQuery ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataQuery struct{}
type DescribeLivePushStreamInfoDataReq ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataReq struct {
*DescribeLivePushStreamInfoDataQuery
*DescribeLivePushStreamInfoDataBody
}
type DescribeLivePushStreamInfoDataRes ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataRes struct {
// REQUIRED
ResponseMetadata DescribeLivePushStreamInfoDataResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeLivePushStreamInfoDataResResult `json:"Result,omitempty"`
}
type DescribeLivePushStreamInfoDataResResponseMetadata ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeLivePushStreamInfoDataResResult ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataResResult struct {
// REQUIRED; 结束时间。格式rfc3339
EndTime string `json:"EndTime"`
// REQUIRED; 分页信息
Pagination DescribeLivePushStreamInfoDataResResultPagination `json:"Pagination"`
// REQUIRED; 按照搜索过滤字段和时间粒度聚合的数据
PushStreamInfoDataList []DescribeLivePushStreamInfoDataResResultPushStreamInfoDataListItem `json:"PushStreamInfoDataList"`
// REQUIRED; 起始时间。格式rfc3339
StartTime string `json:"StartTime"`
// 应用名称
App *string `json:"App,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 直播流名称
Stream *string `json:"Stream,omitempty"`
}
DescribeLivePushStreamInfoDataResResult - 视请求的接口而定
type DescribeLivePushStreamInfoDataResResultPagination ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataResResultPagination struct {
// REQUIRED; 当前页数
PageCur int32 `json:"PageCur"`
// REQUIRED; 每页大小
PageSize int32 `json:"PageSize"`
// REQUIRED; 总共推流个数
TotalCount int32 `json:"TotalCount"`
}
DescribeLivePushStreamInfoDataResResultPagination - 分页信息
type DescribeLivePushStreamInfoDataResResultPushStreamInfoDataListItem ¶ added in v1.0.28
type DescribeLivePushStreamInfoDataResResultPushStreamInfoDataListItem struct {
// REQUIRED; 应用名称
App string `json:"App"`
// REQUIRED; 推流开始到结束的时长,单位s
Duration int32 `json:"Duration"`
// REQUIRED; 推流结束时间,格式rfc3339
EndTime string `json:"EndTime"`
// REQUIRED; 显示推流客户端的IP地址,如没有IP信息,返回空
IP string `json:"IP"`
// REQUIRED; 推流开始时间,格式rfc3339
StartTime string `json:"StartTime"`
// REQUIRED; 直播流名称
Stream string `json:"Stream"`
// REQUIRED; 推流断开原因
StreamBreakReason string `json:"StreamBreakReason"`
}
type DescribeLivePushStreamMetrics ¶
type DescribeLivePushStreamMetrics struct{}
type DescribeLivePushStreamMetricsBody ¶
type DescribeLivePushStreamMetricsBody struct {
// REQUIRED; Application name, which corresponds to the value of theAppNamefield in the live stream address. It can consist
// of uppercase and lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens
// (-), and periods (.), with a length of 1 to 30 characters.
App string `json:"App"`
// REQUIRED; 推流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的推流域名。
Domain string `json:"Domain"`
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// REQUIRED; Stream name, which corresponds to the value of the StreamName field in the live stream address. It can consist
// of uppercase and lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens
// (-), and periods (.), with a length of 1 to 100 characters.
Stream string `json:"Stream"`
// 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
// * 5:5 秒;
// * 30:(默认值)30 秒。
Aggregation *int32 `json:"Aggregation,omitempty"`
}
type DescribeLivePushStreamMetricsQuery ¶
type DescribeLivePushStreamMetricsQuery struct{}
type DescribeLivePushStreamMetricsReq ¶
type DescribeLivePushStreamMetricsReq struct {
*DescribeLivePushStreamMetricsQuery
*DescribeLivePushStreamMetricsBody
}
type DescribeLivePushStreamMetricsRes ¶
type DescribeLivePushStreamMetricsRes struct {
// REQUIRED
ResponseMetadata DescribeLivePushStreamMetricsResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLivePushStreamMetricsResResult `json:"Result,omitempty"`
}
type DescribeLivePushStreamMetricsResResponseMetadata ¶
type DescribeLivePushStreamMetricsResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLivePushStreamMetricsResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLivePushStreamMetricsResResult ¶
type DescribeLivePushStreamMetricsResResult struct {
// Data granularity, measured in seconds.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 应用名称。
App *string `json:"App,omitempty"`
// 推流域名。
Domain *string `json:"Domain,omitempty"`
// The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime *string `json:"EndTime,omitempty"`
// 所有时间粒度的数据。
MetricList []*DescribeLivePushStreamMetricsResResultMetricListItem `json:"MetricList,omitempty"`
// The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime *string `json:"StartTime,omitempty"`
// 流名称。
Stream *string `json:"Stream,omitempty"`
}
type DescribeLivePushStreamMetricsResResultMetricListItem ¶
type DescribeLivePushStreamMetricsResResultMetricListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的音频码率最大值,单位为 kbps。
AudioBitrate float32 `json:"AudioBitrate"`
// REQUIRED; 当前数据聚合时间粒度内,相邻音频帧显示时间戳差值的最大值,单位为毫秒。
AudioFrameGap int32 `json:"AudioFrameGap"`
// REQUIRED; 当前数据聚合时间粒度内的音频帧率最大值,单位为 fps。
AudioFramerate float32 `json:"AudioFramerate"`
// REQUIRED; 当前数据聚合时间粒度内,最后一个音频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
AudioPts int32 `json:"AudioPts"`
// REQUIRED; 当前数据聚合时间粒度内的视频码率最大值,单位为 kbps。
Bitrate float32 `json:"Bitrate"`
// REQUIRED; 当前数据聚合时间粒度内的视频帧率最大值,单位为 fps。
Framerate float32 `json:"Framerate"`
// REQUIRED; 当前数据聚合时间粒度内,所有音视频帧显示时间戳差值的最大值,即所有 AudioPts 与 VideoPts 差值的最大值,单位为毫秒。
PtsDelta int32 `json:"PtsDelta"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内,相邻视频帧显示时间戳差值的最大值,单位为毫秒。
VideoFrameGap int32 `json:"VideoFrameGap"`
// REQUIRED; 当前数据聚合时间粒度内,最后一个视频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
VideoPts int32 `json:"VideoPts"`
}
type DescribeLiveRecordData ¶
type DescribeLiveRecordData struct{}
type DescribeLiveRecordDataBody ¶
type DescribeLiveRecordDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 300 (default): 5 minutes. When aggregated in 5-minute intervals, the maximum time span for a single query is 31 days,
// and for historical queries, the maximum time range is 366 days.
// * 3600: 1 hour. When aggregated in 1-hour intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
// * 86400: 1 day. When aggregated in 1-day intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,当前接口仅支持填写 Domain 表示按查询的域名为维度进行数据拆分。 :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain
// 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的录制用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// The Stream Name must correspond to the value of the StreamName field in the live stream URL. It can include uppercase and
// lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 100 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters must be provided. :::
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveRecordDataQuery ¶
type DescribeLiveRecordDataQuery struct{}
type DescribeLiveRecordDataReq ¶
type DescribeLiveRecordDataReq struct {
*DescribeLiveRecordDataQuery
*DescribeLiveRecordDataBody
}
type DescribeLiveRecordDataRes ¶
type DescribeLiveRecordDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveRecordDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveRecordDataResResult `json:"Result,omitempty"`
}
type DescribeLiveRecordDataResResponseMetadata ¶
type DescribeLiveRecordDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveRecordDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveRecordDataResResult ¶
type DescribeLiveRecordDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 所有时间粒度的数据。
RecordDataList []DescribeLiveRecordDataResResultRecordDataListItem `json:"RecordDataList"`
// REQUIRED; 当前查询条件下的录制并发路数最大值。
RecordPeak int32 `json:"RecordPeak"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 数据拆分的维度,当前接口仅支持按 Domain 即域名维度进行数据拆分。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 按维度拆分后的数据。
RecordDetailDataList []*DescribeLiveRecordDataResResultRecordDetailDataListItem `json:"RecordDetailDataList,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveRecordDataResResultRecordDataListItem ¶
type DescribeLiveRecordDataResResultRecordDataListItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内录制并发路数最大值。
Value int32 `json:"Value"`
}
type DescribeLiveRecordDataResResultRecordDetailDataListItem ¶
type DescribeLiveRecordDataResResultRecordDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
RecordDataList []DescribeLiveRecordDataResResultRecordDetailDataListPropertiesItemsItem `json:"RecordDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的录制并发路数最大值。
RecordPeak int32 `json:"RecordPeak"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
}
type DescribeLiveRecordDataResResultRecordDetailDataListPropertiesItemsItem ¶
type DescribeLiveRecordDataResResultRecordDetailDataListPropertiesItemsItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 录制峰值
Value int32 `json:"Value"`
}
type DescribeLiveRegionData ¶
type DescribeLiveRegionData struct{}
type DescribeLiveRegionDataBody ¶
type DescribeLiveRegionDataBody struct{}
type DescribeLiveRegionDataQuery ¶
type DescribeLiveRegionDataQuery struct{}
type DescribeLiveRegionDataReq ¶
type DescribeLiveRegionDataReq struct {
*DescribeLiveRegionDataQuery
*DescribeLiveRegionDataBody
}
type DescribeLiveRegionDataRes ¶
type DescribeLiveRegionDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveRegionDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveRegionDataResResult `json:"Result"`
}
type DescribeLiveRegionDataResResult ¶
type DescribeLiveRegionDataResResult struct {
// REQUIRED; 区域信息。
Areas []DescribeLiveRegionDataResResultAreasItem `json:"Areas"`
}
type DescribeLiveRegionDataResResultAreasItem ¶
type DescribeLiveRegionDataResResultAreasItem struct {
// REQUIRED; 大区标识符。
Code string `json:"Code"`
// REQUIRED; 国家信息。
Countries []DescribeLiveRegionDataResResultAreasPropertiesItemsItem `json:"Countries"`
// REQUIRED; 大区名称。
Name string `json:"Name"`
}
type DescribeLiveRegionDataResResultAreasPropertiesItemsItem ¶
type DescribeLiveRegionDataResResultAreasPropertiesItemsItem struct {
// REQUIRED; 国家标识符。
Code string `json:"Code"`
// REQUIRED; 国家名称。
Name string `json:"Name"`
// REQUIRED; 省份信息,国外暂不支持该参数。
Provinces []DescribeLiveRegionDataResResultAreasPropertiesItemsProvincesItem `json:"Provinces"`
}
type DescribeLiveSnapshotData ¶
type DescribeLiveSnapshotData struct{}
type DescribeLiveSnapshotDataBody ¶
type DescribeLiveSnapshotDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// 数据聚合的时间粒度,单位为秒,支持的时间粒度如下所示。
// * 300:5 分钟。时间粒度为 5 分钟时,单次查询最大时间跨度为 31 天,历史查询时间范围为 366 天;
// * 3600:1 小时。时间粒度为 1 小时时,单次查询最大时间跨度为 93 天,历史查询时间范围为 366 天;
// * 86400:(默认值)1 天。时间粒度为 1 天时,单次查询最大时间跨度为 93 天,历史查询时间范围为 366 天。
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,当前接口仅支持填写 Domain 表示按查询的域名为维度进行数据拆分。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的截图用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// The Stream Name must correspond to the value of the StreamName field in the live stream URL. It can include uppercase and
// lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 100 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters must be provided. :::
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveSnapshotDataQuery ¶
type DescribeLiveSnapshotDataQuery struct{}
type DescribeLiveSnapshotDataReq ¶
type DescribeLiveSnapshotDataReq struct {
*DescribeLiveSnapshotDataQuery
*DescribeLiveSnapshotDataBody
}
type DescribeLiveSnapshotDataRes ¶
type DescribeLiveSnapshotDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveSnapshotDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveSnapshotDataResResult `json:"Result,omitempty"`
}
type DescribeLiveSnapshotDataResResponseMetadata ¶
type DescribeLiveSnapshotDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveSnapshotDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveSnapshotDataResResult ¶
type DescribeLiveSnapshotDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 所有时间粒度的数据。
SnapshotDataList []DescribeLiveSnapshotDataResResultSnapshotDataListItem `json:"SnapshotDataList"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 当前查询条件下的截图总张数。
Total int32 `json:"Total"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 数据拆分的维度,当前接口仅支持按 Domain 即域名维度进行数据拆分。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 按维度拆分后的数据。
SnapshotDetailData []*DescribeLiveSnapshotDataResResultSnapshotDetailDataItem `json:"SnapshotDetailData,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveSnapshotDataResResultSnapshotDataListItem ¶
type DescribeLiveSnapshotDataResResultSnapshotDataListItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内的截图总张数。
Value int32 `json:"Value"`
}
type DescribeLiveSnapshotDataResResultSnapshotDetailDataItem ¶
type DescribeLiveSnapshotDataResResultSnapshotDetailDataItem struct {
// REQUIRED; 按域名维度进行数据拆分时的域名信息。
Domain string `json:"Domain"`
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
SnapshotDataList []DescribeLiveSnapshotDataResResultSnapshotDetailDataPropertiesItemsItem `json:"SnapshotDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的截图总张数。
Total int32 `json:"Total"`
}
type DescribeLiveSnapshotDataResResultSnapshotDetailDataPropertiesItemsItem ¶
type DescribeLiveSnapshotDataResResultSnapshotDetailDataPropertiesItemsItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 截图总张数
Value int32 `json:"Value"`
}
type DescribeLiveSourceBandwidthData ¶
type DescribeLiveSourceBandwidthData struct{}
type DescribeLiveSourceBandwidthDataBody ¶
type DescribeLiveSourceBandwidthDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying data at the stream granularity, you must specify the Domain, App, and Stream parameters simultaneously.
// :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * ISP:运营商。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tip 查询流粒度的回源带宽监控数据时,需同时指定 Domain 、App
// 和 Stream 来指定回源流。 :::
Domain *string `json:"Domain,omitempty"`
// 拉流域名列表,默认为空,表示查询所有域名的回源带宽监控数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tipDomainList
// 和 Domain 传且仅传一个。 :::
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// The Stream Name is required when querying stream granularity data. It supports uppercase and lowercase letters (A-Z, a-z),
// underscores (_), hyphens (-), and periods (.), with a length of 1 to 100
// characters.
// :::tip When querying stream granularity data, you must specify the Domain, App, and Stream parameters simultaneously. :::
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
UserRegionList []*DescribeLiveSourceBandwidthDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveSourceBandwidthDataBodyUserRegionListItem ¶
type DescribeLiveSourceBandwidthDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveSourceBandwidthDataQuery ¶
type DescribeLiveSourceBandwidthDataQuery struct{}
type DescribeLiveSourceBandwidthDataReq ¶
type DescribeLiveSourceBandwidthDataReq struct {
*DescribeLiveSourceBandwidthDataQuery
*DescribeLiveSourceBandwidthDataBody
}
type DescribeLiveSourceBandwidthDataRes ¶
type DescribeLiveSourceBandwidthDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveSourceBandwidthDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveSourceBandwidthDataResResult `json:"Result,omitempty"`
}
type DescribeLiveSourceBandwidthDataResResponseMetadata ¶
type DescribeLiveSourceBandwidthDataResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *DescribeLiveSourceBandwidthDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveSourceBandwidthDataResResult ¶
type DescribeLiveSourceBandwidthDataResResult struct {
// REQUIRED; 所有时间粒度的数据。
BandwidthDataList []DescribeLiveSourceBandwidthDataResResultBandwidthDataListItem `json:"BandwidthDataList"`
// Data granularity, measured in seconds.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 按维度拆分后的数据。
BandwidthDetailDataList []*DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListItem `json:"BandwidthDetailDataList,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商。
DetailField []*string `json:"DetailField,omitempty"`
// 查询流粒度数据时的域名。
Domain *string `json:"Domain,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime *string `json:"EndTime,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// 查询时间范围内的回源峰值带宽,单位为 Mbps。
PeakBandwidth *float32 `json:"PeakBandwidth,omitempty"`
// The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime *string `json:"StartTime,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveSourceBandwidthDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveSourceBandwidthDataResResultBandwidthDataListItem ¶
type DescribeLiveSourceBandwidthDataResResultBandwidthDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的回源峰值带宽,单位为 Mbps。
Bandwidth float32 `json:"Bandwidth"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListItem ¶
type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListItem struct {
// 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
BandwidthDataList []*DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem `json:"BandwidthDataList,omitempty"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按维度进行数据拆分后,当前维度的回源峰值带宽,单位为 Mbps。
PeakBandwidth *float32 `json:"PeakBandwidth,omitempty"`
}
type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem ¶
type DescribeLiveSourceBandwidthDataResResultBandwidthDetailDataListPropertiesItemsItem struct {
// 时间片内回源带宽峰值,单位 Mbps
Bandwidth *float32 `json:"Bandwidth,omitempty"`
// The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC time with
// second precision.
TimeStamp *string `json:"TimeStamp,omitempty"`
}
type DescribeLiveSourceBandwidthDataResResultUserRegionListItem ¶
type DescribeLiveSourceBandwidthDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveSourceStreamMetrics ¶
type DescribeLiveSourceStreamMetrics struct{}
type DescribeLiveSourceStreamMetricsBody ¶
type DescribeLiveSourceStreamMetricsBody struct {
// REQUIRED; Application name, which corresponds to the value of theAppNamefield in the live stream address. It can consist
// of uppercase and lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens
// (-), and periods (.), with a length of 1 to 30 characters.
App string `json:"App"`
// REQUIRED; 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看回源流使用的拉流域名。
Domain string `json:"Domain"`
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// REQUIRED; Stream name, which corresponds to the value of the StreamName field in the live stream address. It can consist
// of uppercase and lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens
// (-), and periods (.), with a length of 1 to 100 characters.
Stream string `json:"Stream"`
// 数据聚合的时间粒度,单位为秒,当前接口默认且仅支持按 30 秒进行数据聚合。
Aggregation *int32 `json:"Aggregation,omitempty"`
}
type DescribeLiveSourceStreamMetricsQuery ¶
type DescribeLiveSourceStreamMetricsQuery struct{}
type DescribeLiveSourceStreamMetricsReq ¶
type DescribeLiveSourceStreamMetricsReq struct {
*DescribeLiveSourceStreamMetricsQuery
*DescribeLiveSourceStreamMetricsBody
}
type DescribeLiveSourceStreamMetricsRes ¶
type DescribeLiveSourceStreamMetricsRes struct {
// REQUIRED
ResponseMetadata DescribeLiveSourceStreamMetricsResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveSourceStreamMetricsResResult `json:"Result"`
}
type DescribeLiveSourceStreamMetricsResResult ¶
type DescribeLiveSourceStreamMetricsResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 拉流域名。
Domain string `json:"Domain"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 所有时间粒度的数据。
MetricList []DescribeLiveSourceStreamMetricsResResultMetricListItem `json:"MetricList"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
}
type DescribeLiveSourceStreamMetricsResResultMetricListItem ¶
type DescribeLiveSourceStreamMetricsResResultMetricListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的音频码率最大值,单位为 kbps。
AudioBitrate float32 `json:"AudioBitrate"`
// REQUIRED; 当前数据聚合时间粒度内,相邻音频帧显示时间戳差值的最大值,单位为毫秒。
AudioFrameGap int32 `json:"AudioFrameGap"`
// REQUIRED; 当前数据聚合时间粒度内的音频帧率最大值,单位为 fps。
AudioFramerate float32 `json:"AudioFramerate"`
// REQUIRED; 当前数据聚合时间粒度内,最后一个音频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
AudioPts int32 `json:"AudioPts"`
// REQUIRED; 当前数据聚合时间粒度内的视频码率最大值,单位为 kbps。
Bitrate float32 `json:"Bitrate"`
// REQUIRED; 当前数据聚合时间粒度内的视频帧率最大值,单位为 fps
Framerate float32 `json:"Framerate"`
// REQUIRED; 当前数据聚合时间粒度内,所有音视频帧显示时间戳差值的最大值,即所有 AudioPts 与 VideoPts 差值的最大值,单位为毫秒。
PtsDelta int32 `json:"PtsDelta"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内,相邻视频帧显示时间戳差值的最大值,单位为毫秒。
VideoFrameGap int32 `json:"VideoFrameGap"`
// REQUIRED; 当前数据聚合时间粒度内,最后一个视频帧的显示时间戳 PTS(Presentation Time Stamp),单位为毫秒。
VideoPts int32 `json:"VideoPts"`
}
type DescribeLiveSourceTrafficData ¶
type DescribeLiveSourceTrafficData struct{}
type DescribeLiveSourceTrafficDataBody ¶
type DescribeLiveSourceTrafficDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying data at the stream granularity, you must specify the Domain, App, and Stream parameters simultaneously.
// :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * ISP:运营商。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tip 查询流粒度的回源流量监控数据时,需同时指定 Domain 、App
// 和 Stream 来指定回源流。 :::
Domain *string `json:"Domain,omitempty"`
// 拉流域名列表,默认为空,表示查询所有域名的回源流量监控数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tipDomainList 和 Domain 传且仅传一个。 :::
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// The Stream Name is required when querying stream granularity data. It supports uppercase and lowercase letters (A-Z, a-z),
// underscores (_), hyphens (-), and periods (.), with a length of 1 to 100
// characters.
// :::tip When querying stream granularity data, you must specify the Domain, App, and Stream parameters simultaneously. :::
Stream *string `json:"Stream,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
UserRegionList []*DescribeLiveSourceTrafficDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveSourceTrafficDataBodyUserRegionListItem ¶
type DescribeLiveSourceTrafficDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveSourceTrafficDataQuery ¶
type DescribeLiveSourceTrafficDataQuery struct{}
type DescribeLiveSourceTrafficDataReq ¶
type DescribeLiveSourceTrafficDataReq struct {
*DescribeLiveSourceTrafficDataQuery
*DescribeLiveSourceTrafficDataBody
}
type DescribeLiveSourceTrafficDataRes ¶
type DescribeLiveSourceTrafficDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveSourceTrafficDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveSourceTrafficDataResResult `json:"Result,omitempty"`
}
type DescribeLiveSourceTrafficDataResResponseMetadata ¶
type DescribeLiveSourceTrafficDataResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *DescribeLiveSourceTrafficDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveSourceTrafficDataResResult ¶
type DescribeLiveSourceTrafficDataResResult struct {
// REQUIRED; 查询时间范围内的回源总流量,单位为 GB。
TotalTraffic float32 `json:"TotalTraffic"`
// REQUIRED; 所有时间粒度的数据。
TrafficDataList []DescribeLiveSourceTrafficDataResResultTrafficDataListItem `json:"TrafficDataList"`
// Data granularity, measured in seconds.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商。
DetailField []*string `json:"DetailField,omitempty"`
// 查询流粒度数据时的域名。
Domain *string `json:"Domain,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime *string `json:"EndTime,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime *string `json:"StartTime,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
// 按维度拆分后的数据。
TrafficDetailDataList []*DescribeLiveSourceTrafficDataResResultTrafficDetailDataListItem `json:"TrafficDetailDataList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveSourceTrafficDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveSourceTrafficDataResResultTrafficDataListItem ¶
type DescribeLiveSourceTrafficDataResResultTrafficDataListItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内产生的回源流量,单位 GB。
Traffic float32 `json:"Traffic"`
}
type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListItem ¶
type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度的回源总流量,单位为 GB。
TotalTraffic float32 `json:"TotalTraffic"`
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
TrafficDataList []DescribeLiveSourceTrafficDataResResultTrafficDetailDataListPropertiesItemsItem `json:"TrafficDataList"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
}
type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListPropertiesItemsItem ¶
type DescribeLiveSourceTrafficDataResResultTrafficDetailDataListPropertiesItemsItem struct {
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 回源流量,单位 GB
Traffic float32 `json:"Traffic"`
}
type DescribeLiveSourceTrafficDataResResultUserRegionListItem ¶
type DescribeLiveSourceTrafficDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveStorageSpaceData ¶ added in v1.0.28
type DescribeLiveStorageSpaceData struct{}
type DescribeLiveStorageSpaceDataBody ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataBody struct {
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// 时间粒度,单位为 s,支持配置为 86400,单次查询时间跨度为 93 天,历史查询时间范围为 366 天。
Aggregation *int32 `json:"Aggregation,omitempty"`
// 桶名称
Buckets []*string `json:"Buckets,omitempty"`
}
type DescribeLiveStorageSpaceDataQuery ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataQuery struct{}
type DescribeLiveStorageSpaceDataReq ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataReq struct {
*DescribeLiveStorageSpaceDataQuery
*DescribeLiveStorageSpaceDataBody
}
type DescribeLiveStorageSpaceDataRes ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveStorageSpaceDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveStorageSpaceDataResResult `json:"Result"`
}
type DescribeLiveStorageSpaceDataResResponseMetadata ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataResResult ¶ added in v1.0.28
type DescribeLiveStorageSpaceDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 时移存储数据。
StorageDataList []DescribeLiveStorageSpaceDataResResultStorageDataListItem `json:"StorageDataList"`
// 域名空间列表。
Buckets []*string `json:"Buckets,omitempty"`
}
type DescribeLiveStorageSpaceDataResResultStorageDataListItem ¶ added in v1.0.28
type DescribeLiveStreamInfoByPage ¶
type DescribeLiveStreamInfoByPage struct{}
type DescribeLiveStreamInfoByPageBody ¶
type DescribeLiveStreamInfoByPageBody struct{}
type DescribeLiveStreamInfoByPageQuery ¶
type DescribeLiveStreamInfoByPageQuery struct {
// REQUIRED; 查询数据的页码,取值为正整数。
PageNum int32 `json:"PageNum" query:"PageNum"`
// REQUIRED; 每页显示的数据条数,取值范围为 [1,1000]。
PageSize int32 `json:"PageSize" query:"PageSize"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示查询所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty" query:"App"`
// 直播流使用的域名,默认为空,表示查询所有当前域名空间下的在线流。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名。
Domain *string `json:"Domain,omitempty" query:"Domain"`
// 想要查询的目标信息,使用英文逗号作为分隔符“,”,例如,bitrate,framerate。缺省情况下表示 bitrate,framerate。支持如下取值。 all:所有信息;onlineuser:在线人数;bandwidth:带宽信息;bitrate:码率信息;framerate:帧率信息;.
InfoType *string `json:"InfoType,omitempty" query:"InfoType"`
// 使用流名称进行查询的方式,默认值为 strict,支持的取值即含义如下所示。
// * fuzzy:模糊匹配;
// * strict:精准匹配。
QueryType *string `json:"QueryType,omitempty" query:"QueryType"`
// 在线流的来源类型,默认为空,表示查询所有来源类型,支持的取值即含义如下所示。
// * push:直推流;
// * relay:回源流。
SourceType *string `json:"SourceType,omitempty" query:"SourceType"`
// 流名称,取值与直播流地址中 StreamName 字段取值相同,默认为空表示查询所有流名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream *string `json:"Stream,omitempty" query:"Stream"`
// 在线流的流类型,默认为空,表示查询所有类型,支持的取值即含义如下所示。
// * origin:原始流;
// * trans:转码流。
StreamType *string `json:"StreamType,omitempty" query:"StreamType"`
// 域名空间,即直播流地址的域名所属的域名空间,默认为空,表示查询所有域名空间下的在线流。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]
// 页面,查看需要查询的直播流使用的域名所属的域名空间。
Vhost *string `json:"Vhost,omitempty" query:"Vhost"`
}
type DescribeLiveStreamInfoByPageReq ¶
type DescribeLiveStreamInfoByPageReq struct {
*DescribeLiveStreamInfoByPageQuery
*DescribeLiveStreamInfoByPageBody
}
type DescribeLiveStreamInfoByPageRes ¶
type DescribeLiveStreamInfoByPageRes struct {
// REQUIRED
ResponseMetadata DescribeLiveStreamInfoByPageResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveStreamInfoByPageResResult `json:"Result,omitempty"`
}
type DescribeLiveStreamInfoByPageResResponseMetadata ¶
type DescribeLiveStreamInfoByPageResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveStreamInfoByPageResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveStreamInfoByPageResResult ¶
type DescribeLiveStreamInfoByPageResResult struct {
// REQUIRED; 查询结果中在线流的数量。
RoughCount int32 `json:"RoughCount"`
// 在线流信息列表。
StreamInfoList []*DescribeLiveStreamInfoByPageResResultStreamInfoListItem `json:"StreamInfoList,omitempty"`
}
type DescribeLiveStreamInfoByPageResResultStreamInfoListItem ¶
type DescribeLiveStreamInfoByPageResResultStreamInfoListItem struct {
// REQUIRED; 在线流使用的应用名称。
App string `json:"App"`
// REQUIRED; 带宽
BandWidth string `json:"BandWidth"`
// REQUIRED; 码率
Bitrate string `json:"Bitrate"`
// REQUIRED; 在线流使用的域名。
Domain string `json:"Domain"`
// REQUIRED; 帧率
Framerate string `json:"Framerate"`
// REQUIRED; 在线流的 ID。
ID int64 `json:"ID"`
// REQUIRED; 在线人数
OnlineUser string `json:"OnlineUser"`
// REQUIRED; 预览地址
PreviewURL string `json:"PreviewURL"`
// REQUIRED; 在线流的开始时间,RFC3339 格式的 UTC 时间戳,精度为毫秒。
SessionStartTime string `json:"SessionStartTime"`
// REQUIRED; 在线流的来源类型,取值及含义如下所示。
// * push:直推流;
// * relay:回源流。
SourceType string `json:"SourceType"`
// REQUIRED; 在线流使用的流名称。
Stream string `json:"Stream"`
// REQUIRED; 在线流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type DescribeLiveStreamSessionData ¶
type DescribeLiveStreamSessionData struct{}
type DescribeLiveStreamSessionDataBody ¶
type DescribeLiveStreamSessionDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 60: 1 minute. When aggregated every 1 minute, the maximum time span for a single query is 24 hours, and the historical
// query time range is 366 days;
// * 300: (default) 5 minutes. When aggregated every 5 minutes, the maximum time span for a single query is 31 days, and the
// historical query time range is 366 days;
// * 3600: 1 hour. When aggregated every 1 hour, the maximum time span for a single query is 93 days, and the historical query
// time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying data at the stream granularity, you must specify the Domain, App, and Stream parameters simultaneously.
// :::
App *string `json:"App,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下所示。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议;
// * Referer:请求的 Referer 信息。
// :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tip 查询流粒度的请求数和在线人数数据时,需同时指定 Domain 、
// App 和 Stream 来指定直播流。 :::
Domain *string `json:"Domain,omitempty"`
// 拉流域名列表,默认为空,表示查询所有域名的请求数和在线人数。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的拉流域名。
// :::tipDomainList 和 Domain 传且仅传一个。 :::
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// Push-pull streaming protocol. By default, all protocol types are indicated. Supported protocols are as follows.
// * HTTP-FLV: A push-pull streaming protocol based on the HTTP protocol, using the FLV format for video transmission.
// * HTTP-HLS: A push-pull streaming protocol based on the HTTP protocol, using the TS format for video transmission.
// * RTMP: Real-Time Messaging Protocol for real-time message transmission.
// * RTM: Real-Time Media protocol for ultra-low latency live streaming.
// * SRT: Secure Reliable Transport protocol for secure and reliable streaming.
// * QUIC: Quick UDP Internet Connections, a new low-latency internet transmission protocol based on UDP.
// * CMAF: Common Media Application Format, a versatile streaming protocol.
// :::tip If querying the QUIC protocol, other protocols cannot be queried simultaneously. :::
ProtocolList []*string `json:"ProtocolList,omitempty"`
// 指定拉流请求的 Referer 信息,默认为空,表示不对拉流请求的 Referer 字段进行校验。
RefererList []*string `json:"RefererList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions.
RegionList []*DescribeLiveStreamSessionDataBodyRegionListItem `json:"RegionList,omitempty"`
// The Stream Name is required when querying stream granularity data. It supports uppercase and lowercase letters (A-Z, a-z),
// underscores (_), hyphens (-), and periods (.), with a length of 1 to 100
// characters.
// :::tip When querying stream granularity data, you must specify the Domain, App, and Stream parameters simultaneously. :::
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveStreamSessionDataBodyRegionListItem ¶
type DescribeLiveStreamSessionDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveStreamSessionDataQuery ¶
type DescribeLiveStreamSessionDataQuery struct{}
type DescribeLiveStreamSessionDataReq ¶
type DescribeLiveStreamSessionDataReq struct {
*DescribeLiveStreamSessionDataQuery
*DescribeLiveStreamSessionDataBody
}
type DescribeLiveStreamSessionDataRes ¶
type DescribeLiveStreamSessionDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveStreamSessionDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveStreamSessionDataResResult `json:"Result"`
}
type DescribeLiveStreamSessionDataResResult ¶
type DescribeLiveStreamSessionDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; 查询时间范围内的在线人数峰值。
PeakOnlineUser int32 `json:"PeakOnlineUser"`
// REQUIRED; 所有时间粒度的数据。
SessionDataList []DescribeLiveStreamSessionDataResResultSessionDataListItem `json:"SessionDataList"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 查询时间范围内的请求数。
TotalRequest int32 `json:"TotalRequest"`
// 应用名称。
App *string `json:"App,omitempty"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议;
// * Referer:请求的 Referer 信息。
DetailField []*string `json:"DetailField,omitempty"`
// 拉流域名。
Domain *string `json:"Domain,omitempty"`
// List of domains.
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// Push-pull streaming protocol. By default, all protocol types are indicated. Supported protocols are as follows.
// * HTTP-FLV: A push-pull streaming protocol based on the HTTP protocol, using the FLV format for video transmission.
// * HTTP-HLS: A push-pull streaming protocol based on the HTTP protocol, using the TS format for video transmission.
// * RTMP: Real-Time Messaging Protocol for real-time message transmission.
// * RTM: Real-Time Media protocol for ultra-low latency live streaming.
// * SRT: Secure Reliable Transport protocol for secure and reliable streaming.
// * QUIC: Quick UDP Internet Connections, a new low-latency internet transmission protocol based on UDP.
// * CMAF: Common Media Application Format, a versatile streaming protocol.
ProtocolList []*string `json:"ProtocolList,omitempty"`
// 拉流请求的 Referer 信息。
RefererList []*string `json:"RefererList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveStreamSessionDataResResultRegionListItem `json:"RegionList,omitempty"`
// 按维度拆分的数据。
SessionDetailDataList []*DescribeLiveStreamSessionDataResResultSessionDetailDataListItem `json:"SessionDetailDataList,omitempty"`
// 流名称。
Stream *string `json:"Stream,omitempty"`
}
type DescribeLiveStreamSessionDataResResultRegionListItem ¶
type DescribeLiveStreamSessionDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveStreamSessionDataResResultSessionDataListItem ¶
type DescribeLiveStreamSessionDataResResultSessionDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的在线人数最大值。
OnlineUser int32 `json:"OnlineUser"`
// REQUIRED; 当前数据聚合时间粒度内的请求数。
Request int32 `json:"Request"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLiveStreamSessionDataResResultSessionDetailDataListItem ¶
type DescribeLiveStreamSessionDataResResultSessionDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度的在线人数峰值。
PeakOnlineUser int32 `json:"PeakOnlineUser"`
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
SessionDataList []DescribeLiveStreamSessionDataResResultSessionDetailDataListPropertiesItemsItem `json:"SessionDataList"`
// REQUIRED; 按维度进行数据拆分后,当前维度的请求数。
TotalRequest int32 `json:"TotalRequest"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按推拉流协议维度进行数据拆分时的协议信息。
Protocol *string `json:"Protocol,omitempty"`
// 按请求的 Referer 信息进行数据拆分时的 Referer 信息。
Referer *string `json:"Referer,omitempty"`
}
type DescribeLiveStreamSessionDataResResultSessionDetailDataListPropertiesItemsItem ¶
type DescribeLiveStreamSessionDataResResultSessionDetailDataListPropertiesItemsItem struct {
// REQUIRED; 在线人数
OnlineUser int32 `json:"OnlineUser"`
// REQUIRED; 请求数
Request int32 `json:"Request"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
}
type DescribeLiveStreamState ¶
type DescribeLiveStreamState struct{}
type DescribeLiveStreamStateBody ¶
type DescribeLiveStreamStateBody struct{}
type DescribeLiveStreamStateQuery ¶
type DescribeLiveStreamStateQuery struct {
// REQUIRED; 应用名称,取值与直播流地址的 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App" query:"App"`
// REQUIRED; 流名称,取值与直播流地址的 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream string `json:"Stream" query:"Stream"`
// 填写直播流使用的域名,默认为空,表示查询所有直推流和回源流的状态和类型。 您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的直播流使用的域名。
// :::tipVhost 和 Domain 传且仅传一个。 :::
Domain *string `json:"Domain,omitempty" query:"Domain"`
// 域名空间,即直播流地址的域名(Domain)所属的域名空间(Vhost)。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]
// 页面,查看需要查询的直播流使用的域名所属的域名空间。 :::tipVhost 和 Domain 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty" query:"Vhost"`
}
type DescribeLiveStreamStateReq ¶
type DescribeLiveStreamStateReq struct {
*DescribeLiveStreamStateQuery
*DescribeLiveStreamStateBody
}
type DescribeLiveStreamStateRes ¶
type DescribeLiveStreamStateRes struct {
// REQUIRED
ResponseMetadata DescribeLiveStreamStateResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveStreamStateResResult `json:"Result,omitempty"`
}
type DescribeLiveStreamStateResResponseMetadata ¶
type DescribeLiveStreamStateResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveStreamStateResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveTrafficData ¶
type DescribeLiveTrafficData struct{}
type DescribeLiveTrafficDataBody ¶
type DescribeLiveTrafficDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// The granularity of data aggregation, measured in seconds, with the following supported options:
// * 300 (default): 5 minutes. When aggregated in 5-minute intervals, the maximum time span for a single query is 31 days,
// and for historical queries, the maximum time range is 366 days.
// * 3600: 1 hour. When aggregated in 1-hour intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
// * 86400: 1 day. When aggregated in 1-day intervals, the maximum time span for a single query is 93 days, and for historical
// queries, the maximum time range is 366 days.
Aggregation *int32 `json:"Aggregation,omitempty"`
// 数据拆分的维度,默认为空表示不按维度进行数据拆分,支持的维度如下。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议。 :::tip 配置数据拆分的维度时,对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如,配置按 Domain 进行数据拆分时, DomainList 传入多个 Domain 值时,才会返回按 Domain
// 拆分的数据。 :::
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的流量用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Education and Research Network (CERNET);
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: China Broadcasting Network;
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
// If you need to obtain the identifiers of various operators, you can call the DescribeLiveISPData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveispdata].
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong, by default indicating all regions. :::tipRegionList and UserRegionList cannot
// be used together in the same request. :::
RegionList []*DescribeLiveTrafficDataBodyRegionListItem `json:"RegionList,omitempty"`
// 指定查询的流量数据为闲时或忙时,缺省情况下为查询全部数据,支持的取值如下。
// * busy:忙时;
// * free:闲时。
Stage *string `json:"Stage,omitempty"`
// List of regions to which client IPs belong, by default indicating all regions.
// :::tipRegionList and UserRegionList cannot be used together in a single request. :::
UserRegionList []*DescribeLiveTrafficDataBodyUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveTrafficDataBodyRegionListItem ¶
type DescribeLiveTrafficDataBodyRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveTrafficDataBodyUserRegionListItem ¶
type DescribeLiveTrafficDataBodyUserRegionListItem struct {
// The identifier for the major region in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information can be obtained by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata].
// When filtering by
// country, both 'Area' and 'Country' need to be passed in simultaneously.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information is currently not supported for countries or regions outside mainland
// China, Hong Kong, Macao, and Taiwan. You can obtain the identifier information
// by calling DescribeLiveRegionData [https://docs.byteplus.com/en/docs/byteplus-media-live/describeliveregiondata]. When
// filtering by province, you need to simultaneously pass in Area, Country, and
// Province
Province *string `json:"Province,omitempty"`
}
type DescribeLiveTrafficDataQuery ¶
type DescribeLiveTrafficDataQuery struct{}
type DescribeLiveTrafficDataReq ¶
type DescribeLiveTrafficDataReq struct {
*DescribeLiveTrafficDataQuery
*DescribeLiveTrafficDataBody
}
type DescribeLiveTrafficDataRes ¶
type DescribeLiveTrafficDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveTrafficDataResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeLiveTrafficDataResResult `json:"Result"`
}
type DescribeLiveTrafficDataResResult ¶
type DescribeLiveTrafficDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 查询时间范围内的下行总流量,单位为 GB。
TotalDownTraffic float32 `json:"TotalDownTraffic"`
// REQUIRED; 查询时间范围内的上行总流量,单位为 GB。
TotalUpTraffic float32 `json:"TotalUpTraffic"`
// REQUIRED; 所有时间粒度的数据。
TrafficDataList []DescribeLiveTrafficDataResResultTrafficDataListItem `json:"TrafficDataList"`
// 数据拆分的维度,维度说明如下所示。
// * Domain:域名;
// * ISP:运营商;
// * Protocol:推拉流协议。
DetailField []*string `json:"DetailField,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// Identifiers of operators providing network access services. By default, all operators are indicated. Supported operators
// are as follows.
// * unicom: China Unicom;
// * railcom: China Railway Telecom;
// * telecom: China Telecom;
// * mobile: China Mobile;
// * cernet: China Broadcasting Network;
// * tianwei: China Tianwei;
// * alibaba: Alibaba Group;
// * tencent: Tencent Holdings;
// * drpeng: Dr. Peng Telecom & Media Group;
// * btvn: Broadcasting Television Network (BTVN);
// * huashu: Huashu Media;
// * other: Denotes other/unspecified options.
ISPList []*string `json:"ISPList,omitempty"`
// byteplus比火山多了CMAF协议
ProtocolList []*string `json:"ProtocolList,omitempty"`
// List of regions to which CDN node IPs belong.
RegionList []*DescribeLiveTrafficDataResResultRegionListItem `json:"RegionList,omitempty"`
// 流量数据为闲时或忙时,取值说明如下。
// * busy:忙时;
// * free:闲时。
Stage *string `json:"Stage,omitempty"`
// 按维度拆分后的数据。 :::tip 当配置了数据拆分的维度时,对应的维度参数传入多个值才会返回按维度拆分的数据。 :::
TrafficDetailDataList []*DescribeLiveTrafficDataResResultTrafficDetailDataListItem `json:"TrafficDetailDataList,omitempty"`
// List of regions to which client IPs belong.
UserRegionList []*DescribeLiveTrafficDataResResultUserRegionListItem `json:"UserRegionList,omitempty"`
}
type DescribeLiveTrafficDataResResultRegionListItem ¶
type DescribeLiveTrafficDataResResultRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveTrafficDataResResultTrafficDataListItem ¶
type DescribeLiveTrafficDataResResultTrafficDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内产生的总下行流量,单位 GB。
DownTraffic float32 `json:"DownTraffic"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 当前数据聚合时间粒度内产生的总上行流量,单位 GB。
UpTraffic float32 `json:"UpTraffic"`
}
type DescribeLiveTrafficDataResResultTrafficDetailDataListItem ¶
type DescribeLiveTrafficDataResResultTrafficDetailDataListItem struct {
// REQUIRED; 按维度进行数据拆分后,当前维度的下行总流量,单位为 GB。
TotalDownTraffic float32 `json:"TotalDownTraffic"`
// REQUIRED; 按维度进行数据拆分后,当前维度的上行总流量,单位为 GB。
TotalUpTraffic float32 `json:"TotalUpTraffic"`
// REQUIRED; 按维度进行数据拆分后,当前维度下所有时间粒度的数据。
TrafficDataList []DescribeLiveTrafficDataResResultTrafficDetailDataListPropertiesItemsItem `json:"TrafficDataList"`
// 按域名维度进行数据拆分时的域名信息。
Domain *string `json:"Domain,omitempty"`
// 按运营商维度进行数据拆分时的运营商信息。
ISP *string `json:"ISP,omitempty"`
// 按推拉流协议维度进行数据拆分时的协议信息。
Protocol *string `json:"Protocol,omitempty"`
}
type DescribeLiveTrafficDataResResultTrafficDetailDataListPropertiesItemsItem ¶
type DescribeLiveTrafficDataResResultTrafficDetailDataListPropertiesItemsItem struct {
// REQUIRED; 下行流量,单位 GB
DownTraffic float32 `json:"DownTraffic"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 上行流量,单位 GB
UpTraffic float32 `json:"UpTraffic"`
}
type DescribeLiveTrafficDataResResultUserRegionListItem ¶
type DescribeLiveTrafficDataResResultUserRegionListItem struct {
// The regional identifier in regional information.
Area *string `json:"Area,omitempty"`
// The country identifier in the regional information.
Country *string `json:"Country,omitempty"`
// The province identifier in the regional information.
Province *string `json:"Province,omitempty"`
}
type DescribeLiveTranscodeData ¶
type DescribeLiveTranscodeData struct{}
type DescribeLiveTranscodeDataBody ¶
type DescribeLiveTranscodeDataBody struct {
// REQUIRED; The end time of your query's range (UTC time in RFC 3339 format with second precision).
EndTime string `json:"EndTime"`
// REQUIRED; The start time of your query's range (UTC time in RFC 3339 format with second precision).
StartTime string `json:"StartTime"`
// 数据聚合的时间粒度,单位为秒,当前接口默认且仅支持按 86400 秒进行数据聚合。
Aggregation *int32 `json:"Aggregation,omitempty"`
// The Application Name must match the value of the AppName field in the live stream URL. It can include uppercase letters
// (A-Z), lowercase letters (a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 30 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters are required. :::
App *string `json:"App,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的转码用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; - 0P:纯音频流;
Resolution []*string `json:"Resolution,omitempty"`
// The Stream Name must correspond to the value of the StreamName field in the live stream URL. It can include uppercase and
// lowercase letters (A-Z, a-z), numbers (0-9), underscores (_), hyphens (-), and
// periods (.), with a length ranging from 1 to 100 characters.
// :::tip When querying stream granularity data, both the App and Stream parameters must be provided. :::
Stream *string `json:"Stream,omitempty"`
// 视频编码格式,默认为空表示不指定编码格式,支持的取值和含义如下所示。
// * Normal_H264:H.264 标准转码;
// * Normal_H265:H.265 标准转码;
// * Normal_H266:H.266 标准转码;
// * ByteHD_H264:H.264 极智超清;
// * ByteHD_H265:H.265 极智超清;
// * ByteHD_H266:H.266 极智超清;
// * ByteQE:画质增强;
// * Audio:纯音频流。
TranscodeType []*string `json:"TranscodeType,omitempty"`
}
type DescribeLiveTranscodeDataQuery ¶
type DescribeLiveTranscodeDataQuery struct{}
type DescribeLiveTranscodeDataReq ¶
type DescribeLiveTranscodeDataReq struct {
*DescribeLiveTranscodeDataQuery
*DescribeLiveTranscodeDataBody
}
type DescribeLiveTranscodeDataRes ¶
type DescribeLiveTranscodeDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveTranscodeDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveTranscodeDataResResult `json:"Result,omitempty"`
}
type DescribeLiveTranscodeDataResResponseMetadata ¶
type DescribeLiveTranscodeDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveTranscodeDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveTranscodeDataResResult ¶
type DescribeLiveTranscodeDataResResult struct {
// REQUIRED; Data granularity, measured in seconds.
Aggregation int32 `json:"Aggregation"`
// REQUIRED; 查询时间范围内的转码总时长,单位为分钟。
Duration float32 `json:"Duration"`
// REQUIRED; The end time of the query in UTC time, formatted according to RFC3339, with precision to the second.
EndTime string `json:"EndTime"`
// REQUIRED; The start time of the query in UTC time, formatted according to RFC3339, with precision to the second.
StartTime string `json:"StartTime"`
// REQUIRED; 所有时间粒度的数据。
TranscodeDataList []DescribeLiveTranscodeDataResResultTranscodeDataListItem `json:"TranscodeDataList"`
// The application name when querying stream granularity data.
App *string `json:"App,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; - 0P:纯音频流;
Resolution []*string `json:"Resolution,omitempty"`
// The stream name when querying stream granularity data.
Stream *string `json:"Stream,omitempty"`
// 视频编码格式,支持的取值和含义如下所示。- NormalH264:H.264 标准转码; - NormalH265:H.265 标准转码; - NormalH266:H.266 标准转码; - ByteHDH264:H.264 极智超清;
// - ByteHDH265:H.265 极智超清; - ByteHDH266:H.266 极智超清;- ByteQE:画质增强;- Audio:纯音频流;
TranscodeType []*string `json:"TranscodeType,omitempty"`
}
type DescribeLiveTranscodeDataResResultTranscodeDataListItem ¶
type DescribeLiveTranscodeDataResResultTranscodeDataListItem struct {
// REQUIRED; 当前数据聚合时间粒度内的转码时长,单位为分钟。
Duration float32 `json:"Duration"`
// REQUIRED; 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; -
// 0P:纯音频流;
Resolution string `json:"Resolution"`
// REQUIRED; The start time of each time granularity when data is aggregated by time granularity, formatted in RFC3339 UTC
// time with second precision.
TimeStamp string `json:"TimeStamp"`
// REQUIRED; 视频编码格式,支持的取值和含义如下所示。- NormalH264:H.264 标准转码; - NormalH265:H.265 标准转码; - NormalH266:H.266 标准转码; - ByteHDH264:H.264
// 极智超清; - ByteHDH265:H.265 极智超清; - ByteHDH266:H.266 极智超清;- ByteQE:画质增强;- Audio:纯音频流;
TranscodeType string `json:"TranscodeType"`
}
type DescribeLiveTranscodeInfoData ¶ added in v1.0.32
type DescribeLiveTranscodeInfoData struct{}
type DescribeLiveTranscodeInfoDataBody ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataBody struct {
// REQUIRED; 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
EndTime string `json:"EndTime"`
// REQUIRED; 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 :::tip 历史查询最大时间范围为 366 天。 :::
StartTime string `json:"StartTime"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 :::tip 查询流粒度数据时,需同时传入App和Stream。
// :::
App *string `json:"App,omitempty"`
// 域名列表,默认为空,表示查询您视频直播产品下所有域名的转码用量数据。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,获取待查询的域名。
DomainList []*string `json:"DomainList,omitempty"`
// 分页页数,默认1
PageNum *int32 `json:"PageNum,omitempty"`
// 每页大小, 默认20,取值范围[1,100000]
PageSize *int32 `json:"PageSize,omitempty"`
// 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; - 0P:纯音频流;
Resolution []*string `json:"Resolution,omitempty"`
// 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。 :::tip 查询流粒度数据时,需同时传入App和Stream。
// :::
Stream *string `json:"Stream,omitempty"`
// 视频编码格式,支持的取值和含义如下所示。- NormalH264:H.264 标准转码; - NormalH265:H.265 标准转码; - NormalH266:H.266 标准转码; - ByteHDH264:H.264 极智超清;
// - ByteHDH265:H.265 极智超清; - ByteHDH266:H.266 极智超清;- ByteQE:画质增强;- Audio:纯音频流;
TranscodeType []*string `json:"TranscodeType,omitempty"`
}
type DescribeLiveTranscodeInfoDataQuery ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataQuery struct{}
type DescribeLiveTranscodeInfoDataReq ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataReq struct {
*DescribeLiveTranscodeInfoDataQuery
*DescribeLiveTranscodeInfoDataBody
}
type DescribeLiveTranscodeInfoDataRes ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataRes struct {
// REQUIRED
ResponseMetadata DescribeLiveTranscodeInfoDataResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeLiveTranscodeInfoDataResResult `json:"Result,omitempty"`
}
type DescribeLiveTranscodeInfoDataResResponseMetadata ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeLiveTranscodeInfoDataResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeLiveTranscodeInfoDataResResponseMetadataError ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataResResult ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataResResult struct {
// REQUIRED; 查询的结束时间,RFC3339 格式的时间戳,精度为秒。
EndTime string `json:"EndTime"`
// REQUIRED; 分页信息
Pagination DescribeLiveTranscodeInfoDataResResultPagination `json:"Pagination"`
// REQUIRED; 查询的起始时间,RFC3339 格式的时间戳,精度为秒。
StartTime string `json:"StartTime"`
// REQUIRED; 所有时间粒度的数据。
TranscodeInfoDataList []DescribeLiveTranscodeInfoDataResResultTranscodeInfoDataListItem `json:"TranscodeInfoDataList"`
// 查询流粒度数据时的应用名称。
App *string `json:"App,omitempty"`
// 域名列表。
DomainList []*string `json:"DomainList,omitempty"`
// 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; - 0P:纯音频流;
Resolution []*string `json:"Resolution,omitempty"`
// 查询流粒度数据时的流名称。
Stream *string `json:"Stream,omitempty"`
// 视频编码格式,支持的取值和含义如下所示。- NormalH264:H.264 标准转码; - NormalH265:H.265 标准转码; - NormalH266:H.266 标准转码; - ByteHDH264:H.264 极智超清;
// - ByteHDH265:H.265 极智超清; - ByteHDH266:H.266 极智超清;- ByteQE:画质增强;- Audio:纯音频流;
TranscodeType []*string `json:"TranscodeType,omitempty"`
}
type DescribeLiveTranscodeInfoDataResResultPagination ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataResResultPagination struct {
// REQUIRED; 当前页数
PageCur int32 `json:"PageCur"`
// REQUIRED; 每页大小
PageSize int32 `json:"PageSize"`
// REQUIRED; 总个数
TotalCount int32 `json:"TotalCount"`
}
DescribeLiveTranscodeInfoDataResResultPagination - 分页信息
type DescribeLiveTranscodeInfoDataResResultTranscodeInfoDataListItem ¶ added in v1.0.32
type DescribeLiveTranscodeInfoDataResResultTranscodeInfoDataListItem struct {
// REQUIRED; 转码时长,单位分钟
Duration float32 `json:"Duration"`
// REQUIRED; 结束转码时间
EndTime string `json:"EndTime"`
// REQUIRED; 分辨率。- 480P:640 × 480; - 720P:1280 × 720; - 1080P:1920 × 1088; - 2K:2560 × 1440; - 4K:4096 × 2160;- 8K:大于4K; -
// 0P:纯音频流;
Resolution string `json:"Resolution"`
// REQUIRED; 开始转码时间
StartTime string `json:"StartTime"`
// REQUIRED; 流名
Stream string `json:"Stream"`
// REQUIRED; 转码任务ID
TaskID string `json:"TaskID"`
// REQUIRED; 转码后缀
TranscodeSuffix string `json:"TranscodeSuffix"`
// REQUIRED; 视频编码格式,支持的取值和含义如下所示。- NormalH264:H.264 标准转码; - NormalH265:H.265 标准转码; - NormalH266:H.266 标准转码; - ByteHDH264:H.264
// 极智超清; - ByteHDH265:H.265 极智超清; - ByteHDH266:H.266 极智超清;- ByteQE:画质增强;- Audio:纯音频流;
TranscodeType string `json:"TranscodeType"`
}
type DescribeRecordTaskFileHistory ¶
type DescribeRecordTaskFileHistory struct{}
type DescribeRecordTaskFileHistoryBody ¶
type DescribeRecordTaskFileHistoryBody struct {
// REQUIRED; 开始录制时间,RFC3339 格式的时间戳,精度为秒。当您查询指定录制任务详情时,DateFrom 应设置为开始时间之前的任意时间。
DateFrom string `json:"DateFrom"`
// REQUIRED; 结束录制时间,RFC3339 格式的时间戳,精度为秒。结束时间需晚于 DateFrom,且与 DateFrom 间隔不超过 7 天。
DateTo string `json:"DateTo"`
// REQUIRED; 查询数据的页码,默认为 1,表示查询第一页的数据,取值范围为正整数。
PageNum int32 `json:"PageNum"`
// REQUIRED; 每页显示的数据条数,取值范围为正整数。
PageSize int32 `json:"PageSize"`
// 应用名称,取值与直播流地址的 AppName 字段取值相同,默认为空表示查询 vhost 下的所有录制历史。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30
// 个字符。
App *string `json:"App,omitempty"`
// 流名称,取值与直播流地址的 StreamName 字段取值相同,默认为空表示查询 App 下的所有录制历史。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100
// 个字符。 :::tip 如果指定 Stream,必须同时指定 App 的值。 :::
Stream *string `json:"Stream,omitempty"`
// 录制文件保存位置,支持的取值及含义如下所示。
// * tos:存储到 TOS(默认值);
// * vod:存储到 VOD。
Type *string `json:"Type,omitempty"`
// 域名空间,即直播流地址的域名所属的域名空间,默认为空表示查询所有录制历史。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeRecordTaskFileHistoryQuery ¶
type DescribeRecordTaskFileHistoryQuery struct{}
type DescribeRecordTaskFileHistoryReq ¶
type DescribeRecordTaskFileHistoryReq struct {
*DescribeRecordTaskFileHistoryQuery
*DescribeRecordTaskFileHistoryBody
}
type DescribeRecordTaskFileHistoryRes ¶
type DescribeRecordTaskFileHistoryRes struct {
// REQUIRED
ResponseMetadata DescribeRecordTaskFileHistoryResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeRecordTaskFileHistoryResResult `json:"Result,omitempty"`
}
type DescribeRecordTaskFileHistoryResResponseMetadata ¶
type DescribeRecordTaskFileHistoryResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeRecordTaskFileHistoryResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeRecordTaskFileHistoryResResult ¶
type DescribeRecordTaskFileHistoryResResult struct {
// REQUIRED; 录制文件列表。
Data []DescribeRecordTaskFileHistoryResResultDataItem `json:"Data"`
// REQUIRED; 查询结果的分页信息。
Pagination DescribeRecordTaskFileHistoryResResultPagination `json:"Pagination"`
}
type DescribeRecordTaskFileHistoryResResultDataItem ¶
type DescribeRecordTaskFileHistoryResResultDataItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 存储位置为 TOS 时的 Bucket。
Bucket string `json:"Bucket"`
// REQUIRED; 录制时长。
Duration string `json:"Duration"`
// REQUIRED; 结束录制时间。
EndTime string `json:"EndTime"`
// REQUIRED; 结束录制时间,RFC3339 格式的 UTC 时间,精度为秒。
EndTimeUTC string `json:"EndTimeUTC"`
// REQUIRED; 录制文件的文件名。
FileName string `json:"FileName"`
// REQUIRED; 录制文件存储格式。
Format string `json:"Format"`
// REQUIRED; 存储位置为 TOS 时,在 Bucket 中的存储路径。
Path string `json:"Path"`
// REQUIRED; 开始录制时间。
StartTime string `json:"StartTime"`
// REQUIRED; 开始录制时间,RFC3339 格式的 UTC 时间,精度为秒。
StartTimeUTC string `json:"StartTimeUTC"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// REQUIRED; 录制文件保存在 VOD 时,录制文件的 ID。
Vid string `json:"Vid"`
}
type DescribeRecordTaskFileHistoryResResultPagination ¶
type DescribeRecordTaskFileHistoryResResultPagination struct {
// REQUIRED; 当前所在分页的页码。
PageCur int32 `json:"PageCur"`
// REQUIRED; 每页显示的数据条数。
PageSize int32 `json:"PageSize"`
// REQUIRED; 查询结果的数据总页数。
PageTotal int32 `json:"PageTotal"`
// REQUIRED; 查询结果的数据总条数。
TotalCount int32 `json:"TotalCount"`
}
DescribeRecordTaskFileHistoryResResultPagination - 查询结果的分页信息。
type DescribeReferer ¶
type DescribeReferer struct{}
type DescribeRefererBody ¶
type DescribeRefererBody struct {
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 :::tip
// 参数 Domain 和 App 至少传一个。 :::
App *string `json:"App,omitempty"`
// 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的拉流域名。
// :::tip
// * 参数 Domain 和 Vhost 传且仅传一个。
// * 参数 Domain 和 App 至少传一个。 :::
Domain *string `json:"Domain,omitempty"`
// 域名空间,即直播流地址的域名(Domain)所属的域名空间(Vhost)。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看拉流域名所属的域名空间。 :::tip
// 参数 Domain 和 Vhost 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeRefererQuery ¶
type DescribeRefererQuery struct{}
type DescribeRefererReq ¶
type DescribeRefererReq struct {
*DescribeRefererQuery
*DescribeRefererBody
}
type DescribeRefererRes ¶
type DescribeRefererRes struct {
// REQUIRED
ResponseMetadata DescribeRefererResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeRefererResResult `json:"Result,omitempty"`
}
type DescribeRefererResResponseMetadata ¶
type DescribeRefererResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeRefererResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeRefererResResult ¶
type DescribeRefererResResult struct {
// Referer 防盗链信息列表。
RefererList []*DescribeRefererResResultRefererListItem `json:"RefererList,omitempty"`
}
type DescribeRefererResResultRefererListItem ¶
type DescribeRefererResResultRefererListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 拉流域名。
Domain string `json:"Domain"`
// REQUIRED; Referer 防盗链详情列表。
RefererInfoList []DescribeRefererResResultRefererListPropertiesItemsItem `json:"RefererInfoList"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type DescribeRefererResResultRefererListPropertiesItemsItem ¶
type DescribeRefererResResultRefererListPropertiesItemsItem struct {
// REQUIRED; 用于标识 referer 防盗链的关键词,返回值为 referer。
Key string `json:"Key"`
// REQUIRED; 优先级,当前默认返回值为 0。当多域名返回值一致时,按照域名输入顺序区分,越早加入列表的域名优先级越高。
Priority int32 `json:"Priority"`
// REQUIRED; referer 防盗链黑白名单类型,取值即含义如下所示。
// * deny:黑名单;
// * allow:白名单。
Type string `json:"Type"`
// REQUIRED; Referer 字段规则,即设置的黑名单或白名单的域名。
Value string `json:"Value"`
}
type DescribeRegionAccessRule ¶ added in v1.0.28
type DescribeRegionAccessRule struct{}
type DescribeRegionAccessRuleBody ¶ added in v1.0.28
type DescribeRegionAccessRuleQuery ¶ added in v1.0.28
type DescribeRegionAccessRuleQuery struct{}
type DescribeRegionAccessRuleReq ¶ added in v1.0.28
type DescribeRegionAccessRuleReq struct {
*DescribeRegionAccessRuleQuery
*DescribeRegionAccessRuleBody
}
type DescribeRegionAccessRuleRes ¶ added in v1.0.28
type DescribeRegionAccessRuleRes struct {
// REQUIRED
ResponseMetadata DescribeRegionAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *DescribeRegionAccessRuleResResult `json:"Result,omitempty"`
}
type DescribeRegionAccessRuleResResponseMetadata ¶ added in v1.0.28
type DescribeRegionAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type DescribeRegionAccessRuleResResult ¶ added in v1.0.28
type DescribeRegionAccessRuleResResult struct {
// REQUIRED
AccessRuleLists []DescribeRegionAccessRuleResResultAccessRuleListsItem `json:"AccessRuleLists"`
}
DescribeRegionAccessRuleResResult - 视请求的接口而定
type DescribeRegionAccessRuleResResultAccessRuleListsItem ¶ added in v1.0.28
type DescribeRegionAccessRuleResResultAccessRuleListsItem struct {
// REQUIRED
Domain string `json:"Domain"`
// REQUIRED
RegionAccessRule DescribeRegionAccessRuleResResultAccessRuleListsItemRegionAccessRule `json:"RegionAccessRule"`
// REQUIRED
Vhost string `json:"Vhost"`
App *string `json:"App,omitempty"`
}
type DescribeRegionAccessRuleResResultAccessRuleListsItemRegionAccessRule ¶ added in v1.0.28
type DescribeRelaySourceRewrite ¶
type DescribeRelaySourceRewrite struct{}
type DescribeRelaySourceRewriteQuery ¶
type DescribeRelaySourceRewriteQuery struct{}
type DescribeRelaySourceRewriteReq ¶
type DescribeRelaySourceRewriteReq struct {
*DescribeRelaySourceRewriteQuery
*DescribeRelaySourceRewriteBody
}
type DescribeRelaySourceRewriteRes ¶
type DescribeRelaySourceRewriteRes struct {
ResponseMetadata *DescribeRelaySourceRewriteResResponseMetadata `json:"ResponseMetadata,omitempty"`
Result *DescribeRelaySourceRewriteResResult `json:"Result,omitempty"`
}
type DescribeRelaySourceRewriteResResult ¶
type DescribeRelaySourceRewriteResResult struct {
// 回源改写列表
RelaySourceRewriteList *DescribeRelaySourceRewriteResResultRelaySourceRewriteList `json:"RelaySourceRewriteList,omitempty"`
}
type DescribeRelaySourceRewriteResResultRelaySourceRewriteList ¶
type DescribeRelaySourceRewriteResResultRelaySourceRewriteList struct {
// 需要设置黑白名单的拉流域名。域名请在工信部完成备案。
Domain *string `json:"Domain,omitempty"`
// 改写规则
RewriteRule *DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRule `json:"RewriteRule,omitempty"`
// 域名空间名称
Vhost *string `json:"Vhost,omitempty"`
}
DescribeRelaySourceRewriteResResultRelaySourceRewriteList - 回源改写列表
type DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRule ¶
type DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRule struct {
// 功能开关。- true: 开 - false: 关
Enable *bool `json:"Enable,omitempty"`
// 改写规则列表
RewriteRuleList []*DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRuleListItem `json:"RewriteRuleList,omitempty"`
}
DescribeRelaySourceRewriteResResultRelaySourceRewriteListRewriteRule - 改写规则
type DescribeRelaySourceV3 ¶
type DescribeRelaySourceV3 struct{}
type DescribeRelaySourceV3Body ¶
type DescribeRelaySourceV3Body struct {
// REQUIRED; 直播流使用的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名。所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,即直播流地址的AppName字段取值,默认为空,表示查询当前域名空间下所有播放触发回源配置。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty"`
// 回源组名称。
Group *string `json:"Group,omitempty"`
}
type DescribeRelaySourceV3Query ¶
type DescribeRelaySourceV3Query struct{}
type DescribeRelaySourceV3Req ¶
type DescribeRelaySourceV3Req struct {
*DescribeRelaySourceV3Query
*DescribeRelaySourceV3Body
}
type DescribeRelaySourceV3Res ¶
type DescribeRelaySourceV3Res struct {
// REQUIRED
ResponseMetadata DescribeRelaySourceV3ResResponseMetadata `json:"ResponseMetadata"`
Result *DescribeRelaySourceV3ResResult `json:"Result,omitempty"`
}
type DescribeRelaySourceV3ResResponseMetadata ¶
type DescribeRelaySourceV3ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DescribeRelaySourceV3ResResponseMetadataError `json:"Error,omitempty"`
}
type DescribeRelaySourceV3ResResult ¶
type DescribeRelaySourceV3ResResult struct {
// 回源配置列表。
RelaySourceConfigList []*DescribeRelaySourceV3ResResultRelaySourceConfigListItem `json:"RelaySourceConfigList,omitempty"`
}
type DescribeRelaySourceV3ResResultRelaySourceConfigListItem ¶
type DescribeRelaySourceV3ResResultRelaySourceConfigListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 回源组配置详情。
GroupDetails []DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsItem `json:"GroupDetails"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// 组的重试次数
RetryTimes *int64 `json:"RetryTimes,omitempty"`
}
type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsItem ¶
type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsItem struct {
// REQUIRED; 回源组名称。
Group string `json:"Group"`
// REQUIRED; 回源服务器配置列表。
Servers []DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsServersItem `json:"Servers"`
}
type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsServersItem ¶
type DescribeRelaySourceV3ResResultRelaySourceConfigListPropertiesItemsServersItem struct {
// REQUIRED; 回源地址。
RelaySourceDomain string `json:"RelaySourceDomain"`
// REQUIRED; 自定义回源参数。
RelaySourceParams map[string]string `json:"RelaySourceParams"`
// REQUIRED; 回源协议。
RelaySourceProtocol string `json:"RelaySourceProtocol"`
}
type DescribeUserAgentAccessRule ¶ added in v1.0.28
type DescribeUserAgentAccessRule struct{}
type DescribeUserAgentAccessRuleBody ¶ added in v1.0.28
type DescribeUserAgentAccessRuleQuery ¶ added in v1.0.28
type DescribeUserAgentAccessRuleQuery struct{}
type DescribeUserAgentAccessRuleReq ¶ added in v1.0.28
type DescribeUserAgentAccessRuleReq struct {
*DescribeUserAgentAccessRuleQuery
*DescribeUserAgentAccessRuleBody
}
type DescribeUserAgentAccessRuleRes ¶ added in v1.0.28
type DescribeUserAgentAccessRuleRes struct {
// REQUIRED
ResponseMetadata DescribeUserAgentAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result DescribeUserAgentAccessRuleResResult `json:"Result"`
}
type DescribeUserAgentAccessRuleResResponseMetadata ¶ added in v1.0.28
type DescribeUserAgentAccessRuleResResult ¶ added in v1.0.28
type DescribeUserAgentAccessRuleResResult struct {
// REQUIRED
UserAgentList []DescribeUserAgentAccessRuleResResultUserAgentListItem `json:"UserAgentList"`
}
type DescribeUserAgentAccessRuleResResultUserAgentListItem ¶ added in v1.0.28
type DescribeUserAgentAccessRuleResResultUserAgentListItem struct {
Domain *string `json:"Domain,omitempty"`
UaAccessRule *DescribeUserAgentAccessRuleResResultUserAgentListItemUaAccessRule `json:"UaAccessRule,omitempty"`
Vhost *string `json:"Vhost,omitempty"`
}
type DescribeUserAgentAccessRuleResResultUserAgentListItemUaAccessRule ¶ added in v1.0.28
type DisableDomain ¶
type DisableDomain struct{}
type DisableDomainBody ¶
type DisableDomainBody struct {
// REQUIRED; 待禁用域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要待禁用域名的信息。
Domain string `json:"Domain"`
}
type DisableDomainQuery ¶
type DisableDomainQuery struct{}
type DisableDomainReq ¶
type DisableDomainReq struct {
*DisableDomainQuery
*DisableDomainBody
}
type DisableDomainRes ¶
type DisableDomainRes struct {
// REQUIRED
ResponseMetadata DisableDomainResResponseMetadata `json:"ResponseMetadata"`
}
type DisableDomainResResponseMetadata ¶
type DisableDomainResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *DisableDomainResResponseMetadataError `json:"Error,omitempty"`
}
type EnableDomain ¶
type EnableDomain struct{}
type EnableDomainBody ¶
type EnableDomainBody struct {
// REQUIRED; 待启用域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要待启用域名的信息。
Domain string `json:"Domain"`
}
type EnableDomainQuery ¶
type EnableDomainQuery struct{}
type EnableDomainReq ¶
type EnableDomainReq struct {
*EnableDomainQuery
*EnableDomainBody
}
type EnableDomainRes ¶
type EnableDomainRes struct {
// REQUIRED
ResponseMetadata EnableDomainResResponseMetadata `json:"ResponseMetadata"`
}
type EnableDomainResResponseMetadata ¶
type EnableDomainResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *EnableDomainResResponseMetadataError `json:"Error,omitempty"`
}
type EnableHTTPHeaderConfig ¶
type EnableHTTPHeaderConfig struct{}
type EnableHTTPHeaderConfigBody ¶
type EnableHTTPHeaderConfigBody struct {
// REQUIRED; 启用或禁用配置,取值及含义如下所示。
// * true:启用;
// * false:禁用。
Enable bool `json:"Enable"`
// REQUIRED; 0: response 1: request
Phase int32 `json:"Phase"`
// REQUIRED; 域名空间,您可以调用 DescribeHTTPHeaderConfig [https://www.volcengine.com/docs/6469/1232744] 接口查看 HTTP Header 配置的 Vhost
// 取值。
Vhost string `json:"Vhost"`
// 拉流域名,您可以调用 DescribeHTTPHeaderConfig [https://www.volcengine.com/docs/6469/1232744] 接口查看 HTTP Header 配置的 Domain 取值。
Domain *string `json:"Domain,omitempty"`
}
type EnableHTTPHeaderConfigQuery ¶
type EnableHTTPHeaderConfigQuery struct{}
type EnableHTTPHeaderConfigReq ¶
type EnableHTTPHeaderConfigReq struct {
*EnableHTTPHeaderConfigQuery
*EnableHTTPHeaderConfigBody
}
type EnableHTTPHeaderConfigRes ¶
type EnableHTTPHeaderConfigRes struct {
// REQUIRED
ResponseMetadata EnableHTTPHeaderConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type EnableHTTPHeaderConfigResResponseMetadata ¶
type EnableHTTPHeaderConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type ForbidStream ¶
type ForbidStream struct{}
type ForbidStreamBody ¶
type ForbidStreamBody struct {
// REQUIRED; 应用名称,取值与直播流地址的 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 流名称,取值与直播流地址的 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream string `json:"Stream"`
// 直播流使用的域名,您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看待禁推的直播流使用的域名。
// :::tip 参数 Domain 和 Vhost
// 传且仅传一个。 :::
Domain *string `json:"Domain,omitempty"`
// 禁推的结束时间,RFC3339 格式的 UTC 时间,精度为毫秒,禁推有效期最长为 90 天,默认为当前时间加 90 天。
EndTime *string `json:"EndTime,omitempty"`
// 域名空间,即直播流地址的域名(Domain)所属的域名空间(Vhost)。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]
// 页面,查看待禁推的直播流使用的域名所属的域名空间。 :::tip 参数 Domain 和 Vhost 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type ForbidStreamQuery ¶
type ForbidStreamQuery struct{}
type ForbidStreamReq ¶
type ForbidStreamReq struct {
*ForbidStreamQuery
*ForbidStreamBody
}
type ForbidStreamRes ¶
type ForbidStreamRes struct {
// REQUIRED
ResponseMetadata ForbidStreamResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type ForbidStreamResResponseMetadata ¶
type ForbidStreamResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *ForbidStreamResResponseMetadataError `json:"Error,omitempty"`
}
type GeneratePlayURL ¶
type GeneratePlayURL struct{}
type GeneratePlayURLBody ¶
type GeneratePlayURLBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 拉流域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream string `json:"Stream"`
// 拉流地址的过期时间,RFC3339 格式的 UTC 时间,精度为秒,过期后需要重新生成。缺省情况下表示当前时间往后的 7 天。 :::tip 如果同时设置 ValidDuration 和 ExpiredTime,以 ExpiredTime
// 的时间为准。 :::
ExpiredTime *string `json:"ExpiredTime,omitempty"`
// 转码流后缀,默认为空,表示生成源流的拉流地址。配置不为空时表示生成转码流的拉流地址,可通过调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853]
// 接口查询对应流的转码流后缀。
Suffix *string `json:"Suffix,omitempty"`
// CDN 类型,默认值为 fcdn,支持如下取值。
// * fcdn:火山引擎流媒体直播 CDN;
// * 3rd:第三方 CDN。
Type *string `json:"Type,omitempty"`
// 拉流地址的有效时长,单位为秒,超过有效时长后需要重新生成。缺省情况下表示 7 天,取值范围为正整数。 :::tip 如果同时设置 ValidDuration 和 ExpiredTime,以 ExpiredTime 的时间为准。 :::
ValidDuration *int32 `json:"ValidDuration,omitempty"`
// 域名空间名称
Vhost *string `json:"Vhost,omitempty"`
}
type GeneratePlayURLQuery ¶
type GeneratePlayURLQuery struct{}
type GeneratePlayURLReq ¶
type GeneratePlayURLReq struct {
*GeneratePlayURLQuery
*GeneratePlayURLBody
}
type GeneratePlayURLRes ¶
type GeneratePlayURLRes struct {
// REQUIRED
ResponseMetadata GeneratePlayURLResResponseMetadata `json:"ResponseMetadata"`
Result *GeneratePlayURLResResult `json:"Result,omitempty"`
}
type GeneratePlayURLResResponseMetadata ¶
type GeneratePlayURLResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *GeneratePlayURLResResponseMetadataError `json:"Error,omitempty"`
}
type GeneratePlayURLResResult ¶
type GeneratePlayURLResResult struct {
// REQUIRED; 拉流地址信息列表。
URLList []GeneratePlayURLResResultURLListItem `json:"URLList"`
}
type GeneratePlayURLResResultURLListItem ¶
type GeneratePlayURLResResultURLListItem struct {
// REQUIRED; CDN 类型。
// * fcdn:火山引擎流媒体直播 CDN;
// * 3rd:第三方 CDN。
CDN string `json:"CDN"`
// REQUIRED; 协议类型,包括 hls、flv、rtmp、udp 和 cmaf。
Protocol string `json:"Protocol"`
// REQUIRED; 地址类型,取值及含义如下所示。
// * pull:拉流地址;
// * 3rd_play(relay_source):第三方回源地址,当配置了回源且 CDN 类型为第三方 CDN 时返回;
// * 3rd_play(relay_sink):第三方转推地址,当配置了拉流转推且 CDN 类型为第三方 CDN 时返回。
Type string `json:"Type"`
// REQUIRED; 生成的拉流地址。
URL string `json:"URL"`
}
type GeneratePushURL ¶
type GeneratePushURL struct{}
type GeneratePushURLBody ¶
type GeneratePushURLBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
Stream string `json:"Stream"`
// REQUIRED; 域名空间,即推流域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看推流域名所属的域名空间。
Vhost string `json:"Vhost"`
// 推流域名,默认为空,表示生成域名空间下所有推流域名的推流地址。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要的推流域名。
Domain *string `json:"Domain,omitempty"`
// 推流地址的过期时间,RFC3339 格式的时间字符串,精度为秒,过期后需要重新生成。缺省情况下表示当前时间往后的 7 天。 :::tip 如果同时设置 ValidDuration 和 ExpiredTime,以 ExpiredTime 的时间为准。
// :::
ExpiredTime *string `json:"ExpiredTime,omitempty"`
// 推流地址的有效时长,单位为秒,超过有效时长后需要重新生成。缺省情况下表示 7 天,取值范围为正整数。 :::tip 如果同时设置 ValidDuration 和 ExpiredTime,以 ExpiredTime 的时间为准。 :::
ValidDuration *int32 `json:"ValidDuration,omitempty"`
}
type GeneratePushURLQuery ¶
type GeneratePushURLQuery struct{}
type GeneratePushURLReq ¶
type GeneratePushURLReq struct {
*GeneratePushURLQuery
*GeneratePushURLBody
}
type GeneratePushURLRes ¶
type GeneratePushURLRes struct {
// REQUIRED
ResponseMetadata GeneratePushURLResResponseMetadata `json:"ResponseMetadata"`
Result *GeneratePushURLResResult `json:"Result,omitempty"`
}
type GeneratePushURLResResponseMetadata ¶
type GeneratePushURLResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *GeneratePushURLResResponseMetadataError `json:"Error,omitempty"`
}
type GeneratePushURLResResult ¶
type GeneratePushURLResResult struct {
// REQUIRED; RTMP 推流地址。
PushURLList []string `json:"PushURLList"`
// REQUIRED; 推流地址详情。
PushURLListDetail []GeneratePushURLResResultPushURLListDetailItem `json:"PushURLListDetail"`
// REQUIRED; RTM 推流地址。
RtmURLList []string `json:"RtmURLList"`
// REQUIRED; RTMP over SRT 推流地址。
RtmpOverSrtURLList []string `json:"RtmpOverSrtURLList"`
// REQUIRED; TS over SRT 推流地址。
TsOverSrtURLList []string `json:"TsOverSrtURLList"`
// REQUIRED; 网络传输推流地址。
WebTransportURLList []string `json:"WebTransportURLList"`
}
type GeneratePushURLResResultPushURLListDetailItem ¶
type GeneratePushURLResResultPushURLListDetailItem struct {
// REQUIRED; OBS 推流地址,例如,rtmp://push.example.com/live/。
DomainApp string `json:"DomainApp"`
// REQUIRED; OBS 推流名称,例如,streamname1?volcTime=1675652376&volcSecret=c57d247c2f19b395b6ec9b182******7。
StreamSign string `json:"StreamSign"`
// REQUIRED; 推流地址。
URL string `json:"URL"`
}
type GetCloudMixTaskDetail ¶ added in v1.0.32
type GetCloudMixTaskDetail struct{}
type GetCloudMixTaskDetailBody ¶ added in v1.0.32
type GetCloudMixTaskDetailBody struct {
// REQUIRED; 混流任务 ID,您可以通过 ListCloudMixTask [https://www.volcengine.com/docs/6469/1271157] 接口获取混流任务 ID。
TaskID string `json:"TaskID"`
}
type GetCloudMixTaskDetailQuery ¶ added in v1.0.32
type GetCloudMixTaskDetailQuery struct{}
type GetCloudMixTaskDetailReq ¶ added in v1.0.32
type GetCloudMixTaskDetailReq struct {
*GetCloudMixTaskDetailQuery
*GetCloudMixTaskDetailBody
}
type GetCloudMixTaskDetailRes ¶ added in v1.0.32
type GetCloudMixTaskDetailRes struct {
// REQUIRED
ResponseMetadata GetCloudMixTaskDetailResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result GetCloudMixTaskDetailResResult `json:"Result"`
}
type GetCloudMixTaskDetailResResponseMetadata ¶ added in v1.0.32
type GetCloudMixTaskDetailResResponseMetadata struct {
// REQUIRED
RequestID string `json:"RequestID"`
}
type GetCloudMixTaskDetailResResult ¶ added in v1.0.32
type GetCloudMixTaskDetailResResult struct {
// REQUIRED; 请求响应码,取值及含义如下。
// * 0:请求成功;
// * 500:内部处理错误;
// * 400:请求异常。
Code int32 `json:"Code"`
// REQUIRED; 返回的数据。
Data GetCloudMixTaskDetailResResultData `json:"Data"`
// REQUIRED; 请求响应码对应的信息。
Message string `json:"Message"`
}
type GetCloudMixTaskDetailResResultData ¶ added in v1.0.32
type GetCloudMixTaskDetailResResultData struct {
// REQUIRED
AccountID string `json:"AccountID"`
// REQUIRED
LastOperationErrCode int32 `json:"LastOperationErrCode"`
// REQUIRED
LastOperationErrMsg string `json:"LastOperationErrMsg"`
// REQUIRED; 任务最近一次更新的版本标识。
LastOperationIndex int32 `json:"LastOperationIndex"`
// REQUIRED; 任务最近一次成功更新的版本标识。
LastSuccessOperationIndex int32 `json:"LastSuccessOperationIndex"`
// REQUIRED; 混流任务详细配置的 Json 字符串。
Rule string `json:"Rule"`
// REQUIRED; 混流任务状态,取值及含义如下所示。
// * pending:任务调度被阻塞。
// * prepare:正在准备任务资源。
// * runing:任务进行中。
// * prestop:正在清理任务资源。
// * done:任务已结束。
Status string `json:"Status"`
// REQUIRED
TaskErrCode int32 `json:"TaskErrCode"`
// REQUIRED
TaskErrMsg string `json:"TaskErrMsg"`
// REQUIRED
TaskErrSrcIDs string `json:"TaskErrSrcIDs"`
// REQUIRED; 混流任务 ID。
TaskID string `json:"TaskID"`
}
GetCloudMixTaskDetailResResultData - 返回的数据。
type GetHLSEncryptDataKey ¶ added in v1.0.32
type GetHLSEncryptDataKey struct{}
type GetHLSEncryptDataKeyBody ¶ added in v1.0.32
type GetHLSEncryptDataKeyBody struct{}
type GetHLSEncryptDataKeyQuery ¶ added in v1.0.32
type GetHLSEncryptDataKeyQuery struct {
// REQUIRED; 视频直播服务端生成的 M3U8 文件中写入的每个 TS 分片的密钥 ID。
KeyID string `json:"KeyID" query:"KeyID"`
}
type GetHLSEncryptDataKeyReq ¶ added in v1.0.32
type GetHLSEncryptDataKeyReq struct {
*GetHLSEncryptDataKeyQuery
*GetHLSEncryptDataKeyBody
}
type GetHLSEncryptDataKeyRes ¶ added in v1.0.32
type GetHLSEncryptDataKeyRes struct {
// REQUIRED
ResponseMetadata GetHLSEncryptDataKeyResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *GetHLSEncryptDataKeyResResult `json:"Result,omitempty"`
}
type GetHLSEncryptDataKeyResResponseMetadata ¶ added in v1.0.32
type GetHLSEncryptDataKeyResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type GetHLSEncryptDataKeyResResult ¶ added in v1.0.32
type GetHLSEncryptDataKeyResResult struct {
// REQUIRED; 密钥。
DataKey string `json:"DataKey"`
}
GetHLSEncryptDataKeyResResult - 视请求的接口而定
type GetLiveVideoQualityAnalysisTaskDetail ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetail struct{}
type GetLiveVideoQualityAnalysisTaskDetailBody ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailQuery ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailQuery struct{}
type GetLiveVideoQualityAnalysisTaskDetailReq ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailReq struct {
*GetLiveVideoQualityAnalysisTaskDetailQuery
*GetLiveVideoQualityAnalysisTaskDetailBody
}
type GetLiveVideoQualityAnalysisTaskDetailRes ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailRes struct {
// REQUIRED
ResponseMetadata GetLiveVideoQualityAnalysisTaskDetailResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result GetLiveVideoQualityAnalysisTaskDetailResResult `json:"Result"`
}
type GetLiveVideoQualityAnalysisTaskDetailResResponseMetadata ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailResResult ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailResResult struct {
// REQUIRED; 测评任务详细信息。
Task GetLiveVideoQualityAnalysisTaskDetailResResultTask `json:"Task"`
}
type GetLiveVideoQualityAnalysisTaskDetailResResultTask ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailResResultTask struct {
// REQUIRED; 测试任务的持续时长。
Duration int32 `json:"Duration"`
// REQUIRED; 画质测评的打点间隔。
Interval int32 `json:"Interval"`
// REQUIRED; 任务名称。
Name string `json:"Name"`
// REQUIRED; 画质测评结果。
ScoringResult GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResult `json:"ScoringResult"`
// REQUIRED; 测试流的播放地址。
SrcURL string `json:"SrcURL"`
// REQUIRED; 任务 ID。
TaskID string `json:"TaskID"`
}
GetLiveVideoQualityAnalysisTaskDetailResResultTask - 测评任务详细信息。
type GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResult ¶ added in v1.0.32
type GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResult struct {
// REQUIRED; 画质测评结果详细信息。
VQScoreLive []GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResultVQScoreLiveItem `json:"VQScoreLive"`
}
GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResult - 画质测评结果。
type GetLiveVideoQualityAnalysisTaskDetailResResultTaskScoringResultVQScoreLiveItem ¶ added in v1.0.32
type KillStream ¶
type KillStream struct{}
type KillStreamBody ¶
type KillStreamBody struct {
// REQUIRED; 直播流使用的应用名称。
App string `json:"App"`
// REQUIRED; 直播流使用的流名称。
Stream string `json:"Stream"`
// REQUIRED; 域名空间,您可以调用 DescribeLiveStreamInfoByPage [https://www.volcengine.com/docs/6469/1126841] 接口,查看待断开的在线流的信息,包括 Vhost、APP
// 和 Stream。
Vhost string `json:"Vhost"`
// 推流域名。 参数 Domain 和 Vhost传且仅传一个。
Domain *string `json:"Domain,omitempty"`
// 禁推的结束时间,禁推有效期最长为 90 天,默认为当前时间加 90 天
EndTime *string `json:"EndTime,omitempty"`
}
type KillStreamQuery ¶
type KillStreamQuery struct{}
type KillStreamReq ¶
type KillStreamReq struct {
*KillStreamQuery
*KillStreamBody
}
type KillStreamRes ¶
type KillStreamRes struct {
// REQUIRED
ResponseMetadata KillStreamResResponseMetadata `json:"ResponseMetadata"`
}
type KillStreamResResponseMetadata ¶
type KillStreamResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *KillStreamResResponseMetadataError `json:"Error,omitempty"`
}
type ListBindEncryptDRM ¶
type ListBindEncryptDRM struct{}
type ListBindEncryptDRMBody ¶
type ListBindEncryptDRMBody struct {
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示查询符合域名空间取值的所有的 DRM 加密配置。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为
// 1 到 30 个字符。
App *string `json:"App,omitempty"`
}
type ListBindEncryptDRMQuery ¶
type ListBindEncryptDRMQuery struct{}
type ListBindEncryptDRMReq ¶
type ListBindEncryptDRMReq struct {
*ListBindEncryptDRMQuery
*ListBindEncryptDRMBody
}
type ListBindEncryptDRMRes ¶
type ListBindEncryptDRMRes struct {
// REQUIRED
ResponseMetadata ListBindEncryptDRMResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED; 视请求的接口而定
Result ListBindEncryptDRMResResult `json:"Result"`
}
type ListBindEncryptDRMResResponseMetadata ¶
type ListBindEncryptDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type ListBindEncryptDRMResResult ¶
type ListBindEncryptDRMResResult struct {
// DRM 加密配置列表。
DRMBindingList []*ListBindEncryptDRMResResultDRMBindingListItem `json:"DRMBindingList,omitempty"`
}
ListBindEncryptDRMResResult - 视请求的接口而定
type ListBindEncryptDRMResResultDRMBindingListItem ¶
type ListBindEncryptDRMResResultDRMBindingListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 加密类型,支持的取值及含义如下所示。
// * FairPlay:使用 FairPlay 技术的商业 DRM 加密;
// * Widevine:使用 Widevine 技术的商业 DRM 加密;
// * PlayReady:使用 PlayReady 技术的商业 DRM 加密;
// * ClearKey:HLS 标准加密。
// :::tip DRM 加密与 HLS 标准加密不可同时配置。 :::
DRMSystems []string `json:"DRMSystems"`
// REQUIRED; 当前 DRM 配置是否开启,取值及含义如下所示。
// * true:开启;
// * false:关闭。
Enable bool `json:"Enable"`
// REQUIRED; 是否开启源流加密,取值及含义如下所示。
// * true:开启;
// * fasle:不开启。
EncryptOriginStream bool `json:"EncryptOriginStream"`
// REQUIRED; 是否开启转码流加密,取值及含义如下所示。
// * true:开启;
// * fasle:不开启。
EncryptTranscodeStream bool `json:"EncryptTranscodeStream"`
// REQUIRED; 进行 DRM 加密的转码流对应的转码流后缀配置。
EncryptTranscodeSuffix []string `json:"EncryptTranscodeSuffix"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type ListCertV2 ¶
type ListCertV2 struct{}
type ListCertV2Body ¶
type ListCertV2Body struct {
// 火山引擎账号 ID
AccountID *string `json:"AccountID,omitempty"`
// 证书是否启用,默认值为 true,支持的取值及含义如下所示。
// * true:启用证书;
// * false:禁用证书。
Available *bool `json:"Available,omitempty"`
// 证书名称,支持输入证书名称中的关键字,进行模糊查询.
CertName *string `json:"CertName,omitempty"`
// 域名,查询该域名对应的证书,支持精确查询。默认为空,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看域名信息。
Domain *string `json:"Domain,omitempty"`
// 只有填了Available,这个字段才生效。
Expiring *bool `json:"Expiring,omitempty"`
}
type ListCertV2Query ¶
type ListCertV2Query struct{}
type ListCertV2Req ¶
type ListCertV2Req struct {
*ListCertV2Query
*ListCertV2Body
}
type ListCertV2Res ¶
type ListCertV2Res struct {
// REQUIRED
ResponseMetadata ListCertV2ResResponseMetadata `json:"ResponseMetadata"`
Result *ListCertV2ResResult `json:"Result,omitempty"`
}
type ListCertV2ResResponseMetadata ¶
type ListCertV2ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListCertV2ResResponseMetadataError `json:"Error,omitempty"`
}
type ListCertV2ResResult ¶
type ListCertV2ResResult struct {
// 证书列表。
CertList []*ListCertV2ResResultCertListItem `json:"CertList,omitempty"`
}
type ListCertV2ResResultCertListItem ¶
type ListCertV2ResResultCertListItem struct {
// REQUIRED; 与证书绑定的域名列表。
CertDomainList []string `json:"CertDomainList"`
// REQUIRED; 证书 ID。
CertID string `json:"CertID"`
// REQUIRED; 证书名称。
CertName string `json:"CertName"`
// REQUIRED; 证书链 ID。
ChainID string `json:"ChainID"`
// REQUIRED; 火山引擎证书中心证书链 ID。
ChainIDVolc string `json:"ChainIDVolc"`
// REQUIRED; 证书的过期时间,RFC3339 格式的 UTC 时间,精度为秒。
NotAfter string `json:"NotAfter"`
// REQUIRED; 证书的生效日期,RFC3339 格式的 UTC 时间,精度为秒。
NotBefore string `json:"NotBefore"`
// REQUIRED; 项目名称。
ProjectName string `json:"ProjectName"`
// REQUIRED; 证书状态,由证书管理平台返回,支持的取值如下所示。
// * OK:正常;
// * Expire:过期;
// * 30days:有效期剩余 30 天;
// * 15days:有效期剩余 15 天;
// * 7days:有效期剩余 7 天;
// * 1days:有效期剩余 1 天。
Status string `json:"Status"`
}
type ListCloudMixTask ¶ added in v1.0.32
type ListCloudMixTask struct{}
type ListCloudMixTaskBody ¶ added in v1.0.32
type ListCloudMixTaskQuery ¶ added in v1.0.32
type ListCloudMixTaskQuery struct{}
type ListCloudMixTaskReq ¶ added in v1.0.32
type ListCloudMixTaskReq struct {
*ListCloudMixTaskQuery
*ListCloudMixTaskBody
}
type ListCloudMixTaskRes ¶ added in v1.0.32
type ListCloudMixTaskRes struct {
// REQUIRED
ResponseMetadata ListCloudMixTaskResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result ListCloudMixTaskResResult `json:"Result"`
}
type ListCloudMixTaskResResponseMetadata ¶ added in v1.0.32
type ListCloudMixTaskResResponseMetadata struct {
// REQUIRED
RequestID string `json:"RequestID"`
}
type ListCloudMixTaskResResult ¶ added in v1.0.32
type ListCloudMixTaskResResult struct {
// REQUIRED; 请求响应码,取值及含义如下。
// * 0:请求成功;
// * 500:内部处理错误;
// * 400:请求异常。
Code int32 `json:"Code"`
// REQUIRED; 返回的数据。
Data ListCloudMixTaskResResultData `json:"Data"`
// REQUIRED; 请求响应码对应的信息。
Message string `json:"Message"`
}
type ListCloudMixTaskResResultData ¶ added in v1.0.32
type ListCloudMixTaskResResultData struct {
// REQUIRED; 查询结果的数据总条数。
Count int32 `json:"Count"`
// REQUIRED; 查询结果数据详细信息。
Result []ListCloudMixTaskResResultDataResultItem `json:"Result"`
}
ListCloudMixTaskResResultData - 返回的数据。
type ListCloudMixTaskResResultDataResultItem ¶ added in v1.0.32
type ListCloudMixTaskResResultDataResultItem struct {
// REQUIRED
AccountID string `json:"AccountID"`
// REQUIRED
CloudcastID string `json:"CloudcastID"`
// REQUIRED; 混流任务创建时间。
CreatedAt ListCloudMixTaskResResultDataResultItemCreatedAt `json:"CreatedAt"`
// REQUIRED
MesosID string `json:"MesosID"`
// REQUIRED; 混流任务名称。
Name string `json:"Name"`
// REQUIRED
Provider string `json:"Provider"`
// REQUIRED; 混流任务状态,取值及含义如下所示。
// * pending:任务调度被阻塞。
// * prepare:正在准备任务资源。
// * runing:任务进行中。
// * prestop:正在清理任务资源。
// * done:任务已结束。
Status string `json:"Status"`
// REQUIRED; 混流任务结束时间。
StoppedAt ListCloudMixTaskResResultDataResultItemStoppedAt `json:"StoppedAt"`
// REQUIRED; 混流任务 ID。
TaskID string `json:"TaskID"`
// REQUIRED
TaskType string `json:"TaskType"`
// REQUIRED
UID string `json:"UID"`
// REQUIRED; 混流任务更新时间。
UpdatedAt ListCloudMixTaskResResultDataResultItemUpdatedAt `json:"UpdatedAt"`
}
type ListCloudMixTaskResResultDataResultItemCreatedAt ¶ added in v1.0.32
type ListCloudMixTaskResResultDataResultItemCreatedAt struct {
// REQUIRED; 时间。
Time string `json:"Time"`
}
ListCloudMixTaskResResultDataResultItemCreatedAt - 混流任务创建时间。
type ListCloudMixTaskResResultDataResultItemStoppedAt ¶ added in v1.0.32
type ListCloudMixTaskResResultDataResultItemStoppedAt struct {
// REQUIRED
Time string `json:"Time"`
}
ListCloudMixTaskResResultDataResultItemStoppedAt - 混流任务结束时间。
type ListCloudMixTaskResResultDataResultItemUpdatedAt ¶ added in v1.0.32
type ListCloudMixTaskResResultDataResultItemUpdatedAt struct {
// REQUIRED
Time string `json:"Time"`
}
ListCloudMixTaskResResultDataResultItemUpdatedAt - 混流任务更新时间。
type ListCommonTransPresetDetail ¶
type ListCommonTransPresetDetail struct{}
type ListCommonTransPresetDetailBody ¶
type ListCommonTransPresetDetailBody struct {
// 模板名称列表,缺省情况下,表示查询所有系统内置转码档位。
PresetList []*string `json:"PresetList,omitempty"`
}
type ListCommonTransPresetDetailQuery ¶
type ListCommonTransPresetDetailQuery struct{}
type ListCommonTransPresetDetailReq ¶
type ListCommonTransPresetDetailReq struct {
*ListCommonTransPresetDetailQuery
*ListCommonTransPresetDetailBody
}
type ListCommonTransPresetDetailRes ¶
type ListCommonTransPresetDetailRes struct {
// REQUIRED
ResponseMetadata ListCommonTransPresetDetailResResponseMetadata `json:"ResponseMetadata"`
Result *ListCommonTransPresetDetailResResult `json:"Result,omitempty"`
}
type ListCommonTransPresetDetailResResponseMetadata ¶
type ListCommonTransPresetDetailResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListCommonTransPresetDetailResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type ListCommonTransPresetDetailResResult ¶
type ListCommonTransPresetDetailResResult struct {
// 极智超清转码配置。
NarrowBandHDPresetDetail []*ListCommonTransPresetDetailResResultNarrowBandHDPresetDetailItem `json:"NarrowBandHDPresetDetail,omitempty"`
// 标准转码配置。
StandardPresetDetail []*ListCommonTransPresetDetailResResultStandardPresetDetailItem `json:"StandardPresetDetail,omitempty"`
}
type ListCommonTransPresetDetailResResultNarrowBandHDPresetDetailItem ¶
type ListCommonTransPresetDetailResResultNarrowBandHDPresetDetailItem struct {
ALayout *string `json:"ALayout,omitempty"`
AProfile *string `json:"AProfile,omitempty"`
AR *int32 `json:"AR,omitempty"`
AbrMode *int32 `json:"AbrMode,omitempty"`
AccountID *string `json:"AccountID,omitempty"`
// 音频编码格式,支持的取值及含义如下。
// * aac:使用 AAC 编码格式;
// * opus:使用 Opus 编码格式;
// * copy:不进行转码,所有音频编码参数不生效。
Acodec *string `json:"Acodec,omitempty"`
AdvancedParam *string `json:"AdvancedParam,omitempty"`
AllowAudioCopy *int32 `json:"AllowAudioCopy,omitempty"`
AllowVideoCopy *int32 `json:"AllowVideoCopy,omitempty"`
An *int32 `json:"An,omitempty"`
// 视频分辨率自适应模式开关。支持的取值及含义如下。
// * 0:关闭视频分辨率自适应;
// * 1:开启视频分辨率自适应。 :::tip
// * 关闭视频分辨率自适应模式(As 取值为 0)时,转码配置的视频分辨率取视频宽度(Width)和视频高度(Height)的值对转码视频进行拉伸;
// * 开启视频分辨率自适应模式(As 取值为 1)时,转码配置的视频分辨率按照短边长度(ShortSide)、长边长度(LongSide)、视频宽度(Width)、视频高度(Height)的优先级取值,另一边等比缩放。 :::
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
AutoTransAb *int32 `json:"AutoTransAb,omitempty"`
AutoTransAl *int32 `json:"AutoTransAl,omitempty"`
AutoTransAr *int32 `json:"AutoTransAr,omitempty"`
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
BCM *int32 `json:"BCM,omitempty"`
// 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 3,取值为 0 时表示去除 B 帧。
// 最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。
// * 视频编码格式为 H.264 (Vcodec 取值为 h264)时取值范围为 [0,7];
// * 视频编码格式为 H.265 或 H.266 (Vcodec 取值为 h265 或 h266)时取值范围为 [0,3]、7、15。
BFrames *int32 `json:"BFrames,omitempty"`
Describe *string `json:"Describe,omitempty"`
// 帧率,单位为 fps。帧率越大,画面越流畅。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔,单位为秒。
GOP *int32 `json:"GOP,omitempty"`
GopMin *int32 `json:"GopMin,omitempty"`
HVSPre *bool `json:"HVSPre,omitempty"`
// 视频高度。 :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸;
// * 编码格式为 H.266 时,不支持设置 Width 和 Height,请使用自适应配置。 :::
Height *int32 `json:"Height,omitempty"`
// 长边长度。 :::tip
// * 当 As 的取值为 1 即开启宽高自适应时,参数生效,反之则不生效。
// * 当 As 的取值为 1 时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
LookAhead *int32 `json:"LookAhead,omitempty"`
Modifier *string `json:"Modifier,omitempty"`
NvBf *int32 `json:"NvBf,omitempty"`
NvCodec *string `json:"NvCodec,omitempty"`
NvGop *int32 `json:"NvGop,omitempty"`
NvHVSPre *bool `json:"NvHVSPre,omitempty"`
NvLookahead *int32 `json:"NvLookahead,omitempty"`
NvPercent *int32 `json:"NvPercent,omitempty"`
NvPreset *string `json:"NvPreset,omitempty"`
NvPriority *int32 `json:"NvPriority,omitempty"`
NvProfile *string `json:"NvProfile,omitempty"`
NvRefs *int32 `json:"NvRefs,omitempty"`
NvTempAQ *int32 `json:"NvTempAQ,omitempty"`
Ocr *bool `json:"Ocr,omitempty"`
Preset *string `json:"Preset,omitempty"`
PresetKind *int32 `json:"PresetKind,omitempty"`
PresetType *int32 `json:"PresetType,omitempty"`
Qp *int32 `json:"Qp,omitempty"`
RegionConfig *string `json:"RegionConfig,omitempty"`
Revision *string `json:"Revision,omitempty"`
// 转码类型是否为极智超清转码,默认值为 false,取值及含义如下。
// * true:极智超清转码;
// * false:标准转码。
// :::tip 视频编码格式为 H.266 (Vcodec取值为h266)时,转码类型不支持极智超清转码。 :::
Roi *bool `json:"Roi,omitempty"`
SITI *bool `json:"SITI,omitempty"`
// 短边长度。 :::tip
// * 当 As 的取值为 1 即开启宽高自适应时,参数生效,反之则不生效。
// * 当 As 的取值为 1 时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
Status *int32 `json:"Status,omitempty"`
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
// 转码后缀通常以流名称后缀的形式来使用,常见的标识有 _sd、_hd、_uhd,例如,当转码配置的标识为 _hd 时,拉取转码流时转码流的流名名称为 源流的流名称_hd。
SuffixName *string `json:"SuffixName,omitempty"`
Threads *int32 `json:"Threads,omitempty"`
VBRatio *int32 `json:"VBRatio,omitempty"`
VBVBufSize *int32 `json:"VBVBufSize,omitempty"`
VBVMaxRate *int32 `json:"VBVMaxRate,omitempty"`
VLevel *string `json:"VLevel,omitempty"`
VPreset *string `json:"VPreset,omitempty"`
VProfile *string `json:"VProfile,omitempty"`
VR *int32 `json:"VRVr,omitempty"`
VRBBframes *int32 `json:"VRBBframes,omitempty"`
VRBHeightNum *int32 `json:"VRBHeightNum,omitempty"`
VRBPreset *string `json:"VRBPreset,omitempty"`
VRBProfile *string `json:"VRBProfile,omitempty"`
VRBSuffix *string `json:"VRBSuffix,omitempty"`
VRBVb *int32 `json:"VRBVb,omitempty"`
VRBWidthNum *int32 `json:"VRBWidthNum,omitempty"`
VRGop *int32 `json:"VRGop,omitempty"`
VRGopDen *int32 `json:"VRGopDen,omitempty"`
VRHvspre *string `json:"VRHvspre,omitempty"`
VRProjection *string `json:"VRProjection,omitempty"`
VRRoi *string `json:"VRRoi,omitempty"`
VRTBframes *int32 `json:"VRTBframes,omitempty"`
VRTPreset *string `json:"VRTPreset,omitempty"`
VRTProfile *string `json:"VRTProfile,omitempty"`
VRTSuffix *string `json:"VRTSuffix,omitempty"`
VRTVb *int32 `json:"VRTVb,omitempty"`
VRTileMod *int32 `json:"VRTileMod,omitempty"`
VRateCtrl *string `json:"VRateCtrl,omitempty"`
VbThreshold *string `json:"VbThreshold,omitempty"`
Vclass *bool `json:"Vclass,omitempty"`
// 视频编码格式。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式;
// * copy:不进行转码,所有视频编码参数不生效。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 kbps。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
Vn *int32 `json:"Vn,omitempty"`
Watermark *string `json:"Watermark,omitempty"`
// 视频宽度。 :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸;
// * 编码格式为 H.266 时,不支持设置 Width 和 Height,请使用自适应配置。 :::
Width *int32 `json:"Width,omitempty"`
}
type ListCommonTransPresetDetailResResultStandardPresetDetailItem ¶
type ListCommonTransPresetDetailResResultStandardPresetDetailItem struct {
ALayout *string `json:"ALayout,omitempty"`
AProfile *string `json:"AProfile,omitempty"`
AR *int32 `json:"AR,omitempty"`
AbrMode *int32 `json:"AbrMode,omitempty"`
AccountID *string `json:"AccountID,omitempty"`
// 音频编码格式。包括以下 3 种类型。
// * aac:使用 aac 编码格式;
// * copy:不进行转码,所有音频编码参数不生效;
// * opus:使用 opus 编码格式。
Acodec *string `json:"Acodec,omitempty"`
AdvancedParam *string `json:"AdvancedParam,omitempty"`
AllowAudioCopy *int32 `json:"AllowAudioCopy,omitempty"`
AllowVideoCopy *int32 `json:"AllowVideoCopy,omitempty"`
An *int32 `json:"An,omitempty"`
// 宽高自适应模式开关。
// * 0:关闭宽高自适应,按照Width和Height的取值进行拉伸;
// * 1:开启宽高自适应,按照ShortSide或LongSide等比缩放。
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
AutoTransAb *int32 `json:"AutoTransAb,omitempty"`
AutoTransAl *int32 `json:"AutoTransAl,omitempty"`
AutoTransAr *int32 `json:"AutoTransAr,omitempty"`
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
BCM *int32 `json:"BCM,omitempty"`
// 2 个参考帧之间的最大 B 帧数。BFrames取 0 时,表示去 B 帧。
BFrames *int32 `json:"BFrames,omitempty"`
Describe *string `json:"Describe,omitempty"`
// 帧率,单位为 fps。帧率越大,画面越流畅
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔,单位为。
GOP *int32 `json:"GOP,omitempty"`
GopMin *int32 `json:"GopMin,omitempty"`
HVSPre *bool `json:"HVSPre,omitempty"`
// 视频高度。 :::tip 当 As 的取值为 0 时,Width 和 Height 中任意参数取 0,表示保持源流尺寸。 :::
Height *int32 `json:"Height,omitempty"`
// 长边长度。 :::tip 当 As 的取值为 1 时,如果 LongSide 和 ShortSide 都取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
LookAhead *int32 `json:"LookAhead,omitempty"`
Modifier *string `json:"Modifier,omitempty"`
NvBf *int32 `json:"NvBf,omitempty"`
NvCodec *string `json:"NvCodec,omitempty"`
NvGop *int32 `json:"NvGop,omitempty"`
NvHVSPre *bool `json:"NvHVSPre,omitempty"`
NvLookahead *int32 `json:"NvLookahead,omitempty"`
NvPercent *int32 `json:"NvPercent,omitempty"`
NvPreset *string `json:"NvPreset,omitempty"`
NvPriority *int32 `json:"NvPriority,omitempty"`
NvProfile *string `json:"NvProfile,omitempty"`
NvRefs *int32 `json:"NvRefs,omitempty"`
NvTempAQ *int32 `json:"NvTempAQ,omitempty"`
Ocr *bool `json:"Ocr,omitempty"`
Preset *string `json:"Preset,omitempty"`
PresetKind *int32 `json:"PresetKind,omitempty"`
PresetType *int32 `json:"PresetType,omitempty"`
Qp *int32 `json:"Qp,omitempty"`
RegionConfig *string `json:"RegionConfig,omitempty"`
Revision *string `json:"Revision,omitempty"`
// 是否极智超清转码。
// * true:极智超清;
// * false:标准转码。
Roi *bool `json:"Roi,omitempty"`
SITI *bool `json:"SITI,omitempty"`
// 短边长度。 :::tip 当 As 的取值为 1 时,如果 LongSide 和 ShortSide 都取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
Status *int32 `json:"Status,omitempty"`
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码流后缀名
SuffixName *string `json:"SuffixName,omitempty"`
Threads *int32 `json:"Threads,omitempty"`
VBRatio *int32 `json:"VBRatio,omitempty"`
VBVBufSize *int32 `json:"VBVBufSize,omitempty"`
VBVMaxRate *int32 `json:"VBVMaxRate,omitempty"`
VLevel *string `json:"VLevel,omitempty"`
VPreset *string `json:"VPreset,omitempty"`
VProfile *string `json:"VProfile,omitempty"`
VR *int32 `json:"VRVr,omitempty"`
VRBBframes *int32 `json:"VRBBframes,omitempty"`
VRBHeightNum *int32 `json:"VRBHeightNum,omitempty"`
VRBPreset *string `json:"VRBPreset,omitempty"`
VRBProfile *string `json:"VRBProfile,omitempty"`
VRBSuffix *string `json:"VRBSuffix,omitempty"`
VRBVb *int32 `json:"VRBVb,omitempty"`
VRBWidthNum *int32 `json:"VRBWidthNum,omitempty"`
VRGop *int32 `json:"VRGop,omitempty"`
VRGopDen *int32 `json:"VRGopDen,omitempty"`
VRHvspre *string `json:"VRHvspre,omitempty"`
VRProjection *string `json:"VRProjection,omitempty"`
VRRoi *string `json:"VRRoi,omitempty"`
VRTBframes *int32 `json:"VRTBframes,omitempty"`
VRTPreset *string `json:"VRTPreset,omitempty"`
VRTProfile *string `json:"VRTProfile,omitempty"`
VRTSuffix *string `json:"VRTSuffix,omitempty"`
VRTVb *int32 `json:"VRTVb,omitempty"`
VRTileMod *int32 `json:"VRTileMod,omitempty"`
VRateCtrl *string `json:"VRateCtrl,omitempty"`
VbThreshold *string `json:"VbThreshold,omitempty"`
Vclass *bool `json:"Vclass,omitempty"`
// 视频编码格式。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式;
// * copy:不进行转码,所有视频编码参数不生效。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 kbps
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
Vn *int32 `json:"Vn,omitempty"`
Watermark *string `json:"Watermark,omitempty"`
// 视频宽度。 :::tip 当 As 的取值为 0 时,如果 Width 和 Height 中任意参数取 0,表示保持源流尺寸。 :::
Width *int32 `json:"Width,omitempty"`
}
type ListDomainDetail ¶
type ListDomainDetail struct{}
type ListDomainDetailBody ¶
type ListDomainDetailBody struct {
// REQUIRED; 查询数据的页码,取值为 1 时表示查询第一页的数据,取值范围为 [1,1000]。
PageNum int32 `json:"PageNum"`
// REQUIRED; 每页显示的数据条数,取值为 10 时表示每页展示 10 条域名信息,取值范围为 [1, 1000]。
PageSize int32 `json:"PageSize"`
// 域名名称列表,缺省情况下表示全部。
DomainNameList []*string `json:"DomainNameList,omitempty"`
// 域名加速区域列表,缺省情况下表示查看全部。支持的取值如下所示。
// * cn:中国内地;
// * cn-global:全球加速;
// * cn-oversea:海外及港澳台。
DomainRegionList []*string `json:"DomainRegionList,omitempty"`
// 域名状态列表,缺省情况下表示查询全部状态的域名。支持的取值如下所示。
// * 0:正常;
// * 1:审核中;
// * 2:禁用,禁止使用,此时 domain 不生效;
// * 3:删除;
// * 4:审核被驳回。审核不通过,需要重新创建并审核;
// * 5:欠费关停。
DomainStatusList []*int32 `json:"DomainStatusList,omitempty"`
// 域名类型列表,缺省情况下表示全部类型的域名。支持的取值如下所示。
// * push:推流域名;
// * pull-flv:拉流域名。
DomainTypeList []*string `json:"DomainTypeList,omitempty"`
// 域名空间列表,缺省情况下表示查询全部域名空间下的域名。
VhostList []*string `json:"VhostList,omitempty"`
}
type ListDomainDetailQuery ¶
type ListDomainDetailQuery struct{}
type ListDomainDetailReq ¶
type ListDomainDetailReq struct {
*ListDomainDetailQuery
*ListDomainDetailBody
}
type ListDomainDetailRes ¶
type ListDomainDetailRes struct {
// REQUIRED
ResponseMetadata ListDomainDetailResResponseMetadata `json:"ResponseMetadata"`
Result *ListDomainDetailResResult `json:"Result,omitempty"`
}
type ListDomainDetailResResponseMetadata ¶
type ListDomainDetailResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListDomainDetailResResponseMetadataError `json:"Error,omitempty"`
}
type ListDomainDetailResResult ¶
type ListDomainDetailResResult struct {
// REQUIRED; 总记录数。
Total int32 `json:"Total"`
// 域名详细信息列表。
DomainList []*ListDomainDetailResResultDomainListItem `json:"DomainList,omitempty"`
}
type ListDomainDetailResResultDomainListItem ¶
type ListDomainDetailResResultDomainListItem struct {
// REQUIRED; CNAME 信息。
CNAME string `json:"CNAME"`
// REQUIRED; 绑定的 HTTPS 证书支持的泛域名。
CertDomain string `json:"CertDomain"`
// REQUIRED; 绑定的 HTTPS 证书的证书链 ID 信息。
ChainID string `json:"ChainID"`
// REQUIRED; CNAME 状态,取值及含义如下所示。
// * 0:未配置 CNAME;
// * 1:已配置 CNAME。
CnameCheck int32 `json:"CnameCheck"`
// REQUIRED; 域名添加时间,RFC3339 格式的 UTC 时间戳,精度为秒。
CreateTime string `json:"CreateTime"`
// REQUIRED; 推/拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 域名是否可用的状态,取值及含义如下所示。
// * 0:正常,域名为可用状态;
// * 1:配置中,域名为可用状态;
// * 2:不可用,域名为其他的不可用状态。
DomainCheck int32 `json:"DomainCheck"`
// REQUIRED; ICP 备案校验是否通过,是否过期信息。
// * 1:备案正常,未过期;
// * 2:查存不到备案信息。
ICPCheck int32 `json:"ICPCheck"`
// REQUIRED; 域名空间所属的项目名称。
ProjectName string `json:"ProjectName"`
// REQUIRED; 绑定的推流域名。
PushDomain string `json:"PushDomain"`
// REQUIRED; 域名加速区域,取值及含义如下所示。
// * cn:中国大陆;
// * cn-global:全球;
// * cn-oversea:海外及港澳台。
Region string `json:"Region"`
// REQUIRED; 域名状态,取值及含义如下所示。
// * 0:正常;
// * 1:审核中;
// * 2:禁用,禁止使用,此时 domain 不生效;
// * 3:删除;
// * 4:审核被驳回。审核不通过,需要重新创建并审核;
// * 5:欠费关停。
Status int32 `json:"Status"`
// REQUIRED; 域名空间的标签信息。
Tags []ListDomainDetailResResultDomainListPropertiesItemsItem `json:"Tags"`
// REQUIRED; 域名类型,取值及含义如下所示。
// * push:推流域名;
// * pull-flv:拉流域名,包含 RTMP、FLV、HLS 格式。
Type string `json:"Type"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type ListLiveVideoQualityAnalysisTasks ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasks struct{}
type ListLiveVideoQualityAnalysisTasksBody ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksQuery ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksQuery struct{}
type ListLiveVideoQualityAnalysisTasksReq ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksReq struct {
*ListLiveVideoQualityAnalysisTasksQuery
*ListLiveVideoQualityAnalysisTasksBody
}
type ListLiveVideoQualityAnalysisTasksRes ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksRes struct {
// REQUIRED
ResponseMetadata ListLiveVideoQualityAnalysisTasksResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result ListLiveVideoQualityAnalysisTasksResResult `json:"Result"`
}
type ListLiveVideoQualityAnalysisTasksResResponseMetadata ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksResResult ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksResResult struct {
// REQUIRED; 查询的数据的页码。
PageNum int32 `json:"PageNum"`
// REQUIRED; 每页显示的数据条数。
PageSize int32 `json:"PageSize"`
// REQUIRED; 画质测评任务列表。
Tasks []ListLiveVideoQualityAnalysisTasksResResultTasksItem `json:"Tasks"`
}
type ListLiveVideoQualityAnalysisTasksResResultTasksItem ¶ added in v1.0.32
type ListLiveVideoQualityAnalysisTasksResResultTasksItem struct {
// 测评任务持续时长。
Duration *int32 `json:"Duration,omitempty"`
// 任务 ID。
ID *string `json:"ID,omitempty"`
// 画质测评的打点间隔。
Interval *int32 `json:"Interval,omitempty"`
// 任务名称。
Name *string `json:"Name,omitempty"`
// 进行画质测评的直播流地址。
SrcURL *string `json:"SrcURL,omitempty"`
}
type ListPullToPushGroup ¶ added in v1.0.32
type ListPullToPushGroup struct{}
type ListPullToPushGroupBody ¶ added in v1.0.32
type ListPullToPushGroupQuery ¶ added in v1.0.32
type ListPullToPushGroupQuery struct{}
type ListPullToPushGroupReq ¶ added in v1.0.32
type ListPullToPushGroupReq struct {
*ListPullToPushGroupQuery
*ListPullToPushGroupBody
}
type ListPullToPushGroupRes ¶ added in v1.0.32
type ListPullToPushGroupRes struct {
// REQUIRED
ResponseMetadata ListPullToPushGroupResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result *ListPullToPushGroupResResult `json:"Result,omitempty"`
}
type ListPullToPushGroupResResponseMetadata ¶ added in v1.0.32
type ListPullToPushGroupResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type ListPullToPushGroupResResult ¶ added in v1.0.32
type ListPullToPushGroupResResult struct {
// REQUIRED; 拉流转推群组列表。
List []ListPullToPushGroupResResultListItem `json:"List"`
// REQUIRED; 查询结果的数据条数。
Total int32 `json:"Total"`
}
ListPullToPushGroupResResult - 视请求的接口而定
type ListPullToPushGroupResResultListItem ¶ added in v1.0.32
type ListPullToPushGroupResResultListItem struct {
// REQUIRED; 账号。
AccountID string `json:"AccountID"`
// REQUIRED; 群组名称。
Name string `json:"Name"`
// REQUIRED; 群组所属的项目名称。
ProjectName string `json:"ProjectName"`
// REQUIRED; 群组的状态,取值及含义如下所示。
// * 0: 可用;
// * 1: 已删除,不可用。
Status float32 `json:"Status"`
// REQUIRED; 群组的标签信息。
Tags []ListPullToPushGroupResResultListPropertiesItemsItem `json:"Tags"`
}
type ListPullToPushGroupResResultListPropertiesItemsItem ¶ added in v1.0.32
type ListPullToPushTask ¶
type ListPullToPushTask struct{}
type ListPullToPushTaskBody ¶
type ListPullToPushTaskBody struct{}
type ListPullToPushTaskQuery ¶
type ListPullToPushTaskQuery struct {
// 群组名称。
// * 使用主账号调用时,为非必填,默认为空,表示查询所有群组的任务信息。
// * 使用子账号调用时,非必填。
GroupName *string `json:"GroupName,omitempty" query:"GroupName"`
// 查询数据的页码,默认为 1,表示查询第一页的数据。
Page *int32 `json:"Page,omitempty" query:"Page"`
// 每页显示的数据条数,默认为 20,最大值为 500。
Size *int32 `json:"Size,omitempty" query:"Size"`
// 拉流转推任务的名称,不区分大小写,支持模糊查询。 例如,title取值为doc时,则返回任务名称为docspace、docs、DOC等 title 中包含doc关键词的所有任务列表。
Title *string `json:"Title,omitempty" query:"Title"`
}
type ListPullToPushTaskReq ¶
type ListPullToPushTaskReq struct {
*ListPullToPushTaskQuery
*ListPullToPushTaskBody
}
type ListPullToPushTaskRes ¶
type ListPullToPushTaskRes struct {
// REQUIRED
ResponseMetadata ListPullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result ListPullToPushTaskResResult `json:"Result"`
}
type ListPullToPushTaskResResponseMetadata ¶
type ListPullToPushTaskResResponseMetadata struct {
Action *string `json:"Action,omitempty"`
Error *ListPullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
Region *string `json:"Region,omitempty"`
RequestID *string `json:"RequestId,omitempty"`
Service *string `json:"Service,omitempty"`
Version *string `json:"Version,omitempty"`
}
type ListPullToPushTaskResResult ¶
type ListPullToPushTaskResResult struct {
// 任务列表。
List []*ListPullToPushTaskResResultListItem `json:"List,omitempty"`
// 分页数量信息。
Pagination *ListPullToPushTaskResResultPagination `json:"Pagination,omitempty"`
}
type ListPullToPushTaskResResultListItem ¶
type ListPullToPushTaskResResultListItem struct {
// 接收拉流转推任务状态回调的地址。
CallbackURL *string `json:"CallbackURL,omitempty"`
// 续播策略,续播策略指转推点播视频进行直播时出现断流并恢复后,如何继续播放的策略,拉流来源类型为点播视频时参数生效,支持的取值及含义如下。
// * 0:从断流处续播(默认值);
// * 1:从断流处+自然流逝时长处续播。
ContinueStrategy *int32 `json:"ContinueStrategy,omitempty"`
// 点播视频文件循环播放模式,当拉流来源类型为点播视频时配置生效,参数取值及含义如下所示。
// * -1:无限次循环,至任务结束;
// * 0:有限次循环,循环次数以 PlayTimes 取值为准;
// * >0:有限次循环,循环次数以 CycleMode 取值为准。
CycleMode *int32 `json:"CycleMode,omitempty"`
// 推流地址,即直播源或点播视频转推的目标地址。
DstAddr *string `json:"DstAddr,omitempty"`
// 推流地址类型。
// * 1:非第三方,即推流地址域名已添加到视频直播。
// * 2:第三方,即推流地址域名未添加到视频直播。
DstAddrType *int32 `json:"DstAddrType,omitempty"`
// 任务的结束时间,RFC3339 格式的 UTC 时间,单位为秒。
EndTime *string `json:"EndTime,omitempty"`
// 任务所属的群组名称,您可以调用 ListPullToPushGroup [https://www.volcengine.com/docs/6469/1327382] 获取可用的群组。 :::tip
// * 使用主账号调用时,为非必填,默认为空表示查询所有群组的任务列表。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
// 点播文件启播时间偏移值,单位为秒,数量与拉流地址列表中地址数量相等,缺省情况下为空表示不进行偏移。拉流来源类型为点播视频时,参数生效。
OffsetS []*float32 `json:"OffsetS,omitempty"`
// 点播视频文件循环播放次数,当 CycleMode 取值为 0 时,PlayTimes 取值将作为循环播放次数。
PlayTimes *int32 `json:"PlayTimes,omitempty"`
// 是否开启点播预热,开启点播预热后,系统会自动将点播视频文件缓存到 CDN 节点上,当用户请求直播时,可以直播从 CDN 节点获取视频,从而提高直播流畅度。拉流来源类型为点播视频时,参数生效。
// * 0:不开启;
// * 1:开启。
PreDownload *int32 `json:"PreDownload,omitempty"`
// 直播源的拉流地址,拉流来源类型为直播源时返回此值。
SrcAddr *string `json:"SrcAddr,omitempty"`
// 点播视频播放地址列表,拉流来源类型为点播视频时返回此值。
SrcAddrS []*string `json:"SrcAddrS,omitempty"`
// 任务的开始时间,RFC3339 格式的 UTC 时间,单位为秒。
StartTime *string `json:"StartTime,omitempty"`
// 拉流转推任务的状态,支持如下取值。
// * 停用;
// * 未开始;
// * 生效中;
// * 已结束。
Status *string `json:"Status,omitempty"`
// 任务 ID,任务的唯一标识。
TaskID *string `json:"TaskId,omitempty"`
// 拉流转推任务的名称。
Title *string `json:"Title,omitempty"`
// 拉流来源类型,支持的取值及含义如下。
// * 0:直播源;
// * 1:点播视频。
Type *int32 `json:"Type,omitempty"`
// 点播文件地址和开始播放、结束播放的时间设置。 :::tip
// * 当 Type 为点播类型时配置生效。
// * 与 SrcAddrS 和 OffsetS 字段不可同时填写。 :::
VodSrcAddrs []*ComponentsGg7M1TSchemasListpulltopushtaskresPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems `json:"VodSrcAddrs,omitempty"`
// 为拉流转推视频添加的水印配置信息。
Watermark *ListPullToPushTaskResResultListItemWatermark `json:"Watermark,omitempty"`
}
type ListPullToPushTaskResResultListItemWatermark ¶
type ListPullToPushTaskResResultListItemWatermark struct {
// REQUIRED; 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/<mediatype>;base64,<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
// 例如,data:image/png;base64,iVBORw0KGg****mCC
Picture string `json:"Picture"`
// REQUIRED; 水印宽度占直播原始画面宽度百分比,支持精度为小数点后两位。
Ratio float32 `json:"Ratio"`
// REQUIRED; 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosX float32 `json:"RelativePosX"`
// REQUIRED; 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosY float32 `json:"RelativePosY"`
}
ListPullToPushTaskResResultListItemWatermark - 为拉流转推视频添加的水印配置信息。
type ListPullToPushTaskResResultPagination ¶
type ListPullToPushTaskResResultPagination struct {
// 当前任务所在分页。
PageCur *int32 `json:"PageCur,omitempty"`
// 每页显示的数据条数。
PageSize *int32 `json:"PageSize,omitempty"`
// 查询结果的数据总页数。
PageTotal *int32 `json:"PageTotal,omitempty"`
// 查询结果的数据总条数。
TotalCount *int32 `json:"TotalCount,omitempty"`
}
ListPullToPushTaskResResultPagination - 分页数量信息。
type ListPullToPushTaskV2 ¶ added in v1.0.32
type ListPullToPushTaskV2 struct{}
type ListPullToPushTaskV2Body ¶ added in v1.0.32
type ListPullToPushTaskV2Body struct {
// 群组名称。
GroupNames []*string `json:"GroupNames,omitempty"`
// 查询数据的页码,默认为 1,表示查询第一页的数据。
Page *int32 `json:"Page,omitempty"`
// 每页显示的数据条数,默认为 20,最大值为 500。
Size *int32 `json:"Size,omitempty"`
// 拉流转推任务的名称,不区分大小写,支持模糊查询。 例如,title取值为doc时,则返回任务名称为docspace、docs、DOC等 title 中包含doc关键词的所有任务列表。
Title *string `json:"Title,omitempty"`
}
type ListPullToPushTaskV2Query ¶ added in v1.0.32
type ListPullToPushTaskV2Query struct{}
type ListPullToPushTaskV2Req ¶ added in v1.0.32
type ListPullToPushTaskV2Req struct {
*ListPullToPushTaskV2Query
*ListPullToPushTaskV2Body
}
type ListPullToPushTaskV2Res ¶ added in v1.0.32
type ListPullToPushTaskV2Res struct {
// REQUIRED
ResponseMetadata ListPullToPushTaskV2ResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result ListPullToPushTaskV2ResResult `json:"Result"`
}
type ListPullToPushTaskV2ResResponseMetadata ¶ added in v1.0.32
type ListPullToPushTaskV2ResResponseMetadata struct {
Action *string `json:"Action,omitempty"`
Error *ListPullToPushTaskV2ResResponseMetadataError `json:"Error,omitempty"`
Region *string `json:"Region,omitempty"`
RequestID *string `json:"RequestId,omitempty"`
Service *string `json:"Service,omitempty"`
Version *string `json:"Version,omitempty"`
}
type ListPullToPushTaskV2ResResponseMetadataError ¶ added in v1.0.32
type ListPullToPushTaskV2ResResult ¶ added in v1.0.32
type ListPullToPushTaskV2ResResult struct {
// 任务列表。
List []*ListPullToPushTaskV2ResResultListItem `json:"List,omitempty"`
// 分页数量信息。
Pagination *ListPullToPushTaskV2ResResultPagination `json:"Pagination,omitempty"`
}
type ListPullToPushTaskV2ResResultListItem ¶ added in v1.0.32
type ListPullToPushTaskV2ResResultListItem struct {
// 接收拉流转推任务状态回调的地址。
CallbackURL *string `json:"CallbackURL,omitempty"`
// 续播策略,续播策略指转推点播视频进行直播时出现断流并恢复后,如何继续播放的策略,拉流来源类型为点播视频时参数生效,支持的取值及含义如下。
// * 0:从断流处续播(默认值);
// * 1:从断流处+自然流逝时长处续播。
ContinueStrategy *int32 `json:"ContinueStrategy,omitempty"`
// 点播视频文件循环播放模式,当拉流来源类型为点播视频(Type 为 1)时配置生效,参数取值及含义如下所示。
// * -1:无限循环,至任务结束;
// * 0:有限次循环,循环次数为 PlayTimes 取值为准。
CycleMode *int32 `json:"CycleMode,omitempty"`
// 推流地址,即直播源或点播视频转推的目标地址。
DstAddr *string `json:"DstAddr,omitempty"`
// 推流地址类型。
// * 1:非第三方,即推流地址域名已添加到视频直播。
// * 2:第三方,即推流地址域名未添加到视频直播。
DstAddrType *int32 `json:"DstAddrType,omitempty"`
// 任务的结束时间,RFC3339 格式的 UTC 时间,单位为秒。
EndTime *string `json:"EndTime,omitempty"`
// 任务所属的群组名称,您可以调用 ListPullToPushGroup [https://www.volcengine.com/docs/6469/1327382] 获取可用的群组。 :::tip
// * 使用主账号调用时,为非必填,默认为空表示查询所有群组的任务列表。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
// 点播文件启播时间偏移值,单位为秒,数量与拉流地址列表中地址数量相等,缺省情况下为空表示不进行偏移。拉流来源类型为点播视频时,参数生效。
OffsetS []*float32 `json:"OffsetS,omitempty"`
// 点播视频文件循环播放次数,当循环播放模式为有限次循环(CycleMode为0)时配置生效。
PlayTimes *int32 `json:"PlayTimes,omitempty"`
// 是否开启点播预热,开启点播预热后,系统会自动将点播视频文件缓存到 CDN 节点上,当用户请求直播时,可以直播从 CDN 节点获取视频,从而提高直播流畅度。拉流来源类型为点播视频时,参数生效。
// * 0:不开启;
// * 1:开启。
PreDownload *int32 `json:"PreDownload,omitempty"`
// 直播源的拉流地址,拉流来源类型为直播源(Type 为 0)时返回此值。
SrcAddr *string `json:"SrcAddr,omitempty"`
// 点播视频播放地址列表,拉流来源类型为点播视频(type 为 1)时返回此值。
SrcAddrS []*string `json:"SrcAddrS,omitempty"`
// 任务的开始时间,RFC3339 格式的 UTC 时间,单位为秒。
StartTime *string `json:"StartTime,omitempty"`
// 拉流转推任务的状态,支持如下取值。
// * 停用;
// * 未开始;
// * 生效中;
// * 已结束。
Status *string `json:"Status,omitempty"`
// 任务 ID,任务的唯一标识。
TaskID *string `json:"TaskId,omitempty"`
// 拉流转推任务的名称。
Title *string `json:"Title,omitempty"`
// 拉流来源类型,支持的取值及含义如下。
// * 0:直播源;
// * 1:点播视频。
Type *int32 `json:"Type,omitempty"`
// 点播文件地址和开始播放、结束播放的时间设置。 :::tip
// * 当 Type 为点播类型时配置生效。
// * 与 SrcAddrS 和 OffsetS 字段不可同时填写。 :::
VodSrcAddrs []*Components1Nf1A8CSchemasListpulltopushtaskv2ResPropertiesResultPropertiesListItemsPropertiesVodsrcaddrsItems `json:"VodSrcAddrs,omitempty"`
// 为拉流转推视频添加的水印配置信息。
Watermark *ListPullToPushTaskV2ResResultListItemWatermark `json:"Watermark,omitempty"`
}
type ListPullToPushTaskV2ResResultListItemWatermark ¶ added in v1.0.32
type ListPullToPushTaskV2ResResultListItemWatermark struct {
// REQUIRED; 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/<mediatype>;base64,<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
// 例如,data:image/png;base64,iVBORw0KGg****mCC
Picture string `json:"Picture"`
// REQUIRED; 水印宽度占直播原始画面宽度百分比,支持精度为小数点后两位。
Ratio float32 `json:"Ratio"`
// REQUIRED; 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosX float32 `json:"RelativePosX"`
// REQUIRED; 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosY float32 `json:"RelativePosY"`
}
ListPullToPushTaskV2ResResultListItemWatermark - 为拉流转推视频添加的水印配置信息。
type ListPullToPushTaskV2ResResultPagination ¶ added in v1.0.32
type ListPullToPushTaskV2ResResultPagination struct {
// 当前任务所在分页。
PageCur *int32 `json:"PageCur,omitempty"`
// 每页显示的数据条数。
PageSize *int32 `json:"PageSize,omitempty"`
// 查询结果的数据总页数。
PageTotal *int32 `json:"PageTotal,omitempty"`
// 查询结果的数据总条数。
TotalCount *int32 `json:"TotalCount,omitempty"`
}
ListPullToPushTaskV2ResResultPagination - 分页数量信息。
type ListTimeShiftPresetV2 ¶
type ListTimeShiftPresetV2 struct{}
type ListTimeShiftPresetV2Body ¶
type ListTimeShiftPresetV2Body struct {
// REQUIRED; 时移类型,默认类型为 vod。
// * vod:点播时移,表示查询时移录制存储在 VOD 中的时移配置;
// * tos:直播时移,表示查询时移录制存储在 TOS 以及 fcdn-tos 中的时移配置。
Type string `json:"Type"`
// 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要时移的直播流使用的域名所属的域名空间。
Vhost *string `json:"Vhost,omitempty"`
}
type ListTimeShiftPresetV2Query ¶
type ListTimeShiftPresetV2Query struct{}
type ListTimeShiftPresetV2Req ¶
type ListTimeShiftPresetV2Req struct {
*ListTimeShiftPresetV2Query
*ListTimeShiftPresetV2Body
}
type ListTimeShiftPresetV2Res ¶
type ListTimeShiftPresetV2Res struct {
// REQUIRED
ResponseMetadata ListTimeShiftPresetV2ResResponseMetadata `json:"ResponseMetadata"`
Result *ListTimeShiftPresetV2ResResult `json:"Result,omitempty"`
}
type ListTimeShiftPresetV2ResResponseMetadata ¶
type ListTimeShiftPresetV2ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListTimeShiftPresetV2ResResponseMetadataError `json:"Error,omitempty"`
}
type ListTimeShiftPresetV2ResResult ¶
type ListTimeShiftPresetV2ResResult struct {
// 时移配置列表。
List []*ListTimeShiftPresetV2ResResultListItem `json:"List,omitempty"`
}
type ListTimeShiftPresetV2ResResultListItem ¶
type ListTimeShiftPresetV2ResResultListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; TOS 存储对应的 Bucket。
Bucket string `json:"Bucket"`
// REQUIRED; 拉流域名。
Domain string `json:"Domain"`
// REQUIRED; 最大时移时长,即允许用户回看的最长时间,单位为秒。
MaxShiftTime int32 `json:"MaxShiftTime"`
// REQUIRED; 时移配置名称。
Name string `json:"Name"`
// REQUIRED; 直播时移配置启用状态。
// * 0:配置中;
// * 1:已启用。
Status int32 `json:"Status"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
// REQUIRED; 类型。默认类型为 vod。
// * vod:录制类型为录制时移时,录制配置中存储位置为 VOD。
// * tos:录制类型为录制时移时,录制配置中存储喂食为 TOS。
// * fcdn-toS:独立时移。
Type string `json:"Type"`
// REQUIRED; 视频点播(VOD)空间名称。
VODNamespace string `json:"VODNamespace"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
}
type ListVhostRecordPresetV2 ¶
type ListVhostRecordPresetV2 struct{}
type ListVhostRecordPresetV2Body ¶
type ListVhostRecordPresetV2Body struct {
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要录制的直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 直播录制的存储类型,默认值为 tos,支持的取值及含义如下所示。
// * vod:录制文件存在 VOD;
// * tos:录制文件存在 TOS。
Type *string `json:"Type,omitempty"`
}
type ListVhostRecordPresetV2Query ¶
type ListVhostRecordPresetV2Query struct{}
type ListVhostRecordPresetV2Req ¶
type ListVhostRecordPresetV2Req struct {
*ListVhostRecordPresetV2Query
*ListVhostRecordPresetV2Body
}
type ListVhostRecordPresetV2Res ¶
type ListVhostRecordPresetV2Res struct {
// REQUIRED
ResponseMetadata ListVhostRecordPresetV2ResResponseMetadata `json:"ResponseMetadata"`
Result *ListVhostRecordPresetV2ResResult `json:"Result,omitempty"`
}
type ListVhostRecordPresetV2ResResponseMetadata ¶
type ListVhostRecordPresetV2ResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *ListVhostRecordPresetV2ResResponseMetadataError `json:"Error,omitempty"`
}
type ListVhostRecordPresetV2ResResult ¶
type ListVhostRecordPresetV2ResResult struct {
// REQUIRED; 录制配置列表。
PresetList []ListVhostRecordPresetV2ResResultPresetListItem `json:"PresetList"`
}
type ListVhostRecordPresetV2ResResultPresetListItem ¶
type ListVhostRecordPresetV2ResResultPresetListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 流名称。
Stream string `json:"Stream"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
// 录制参数详细信息。
SlicePresetV2 *ListVhostRecordPresetV2ResResultPresetListItemSlicePresetV2 `json:"SlicePresetV2,omitempty"`
}
type ListVhostRecordPresetV2ResResultPresetListItemSlicePresetV2 ¶
type ListVhostRecordPresetV2ResResultPresetListItemSlicePresetV2 struct {
// 录制配置 ID。
ID *int32 `json:"ID,omitempty"`
// 录制配置名称。
Name *string `json:"Name,omitempty"`
// 录制模板详细配置。
RecordPresetConfig *ComponentsFuamuzSchemasListvhostrecordpresetv2ResPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetv2PropertiesRecordpresetconfig `json:"RecordPresetConfig,omitempty"`
}
ListVhostRecordPresetV2ResResultPresetListItemSlicePresetV2 - 录制参数详细信息。
type ListVhostSnapshotPreset ¶
type ListVhostSnapshotPreset struct{}
type ListVhostSnapshotPresetQuery ¶
type ListVhostSnapshotPresetQuery struct{}
type ListVhostSnapshotPresetReq ¶
type ListVhostSnapshotPresetReq struct {
*ListVhostSnapshotPresetQuery
*ListVhostSnapshotPresetBody
}
type ListVhostSnapshotPresetRes ¶
type ListVhostSnapshotPresetRes struct {
// REQUIRED
ResponseMetadata ListVhostSnapshotPresetResResponseMetadata `json:"ResponseMetadata"`
Result *ListVhostSnapshotPresetResResult `json:"Result,omitempty"`
}
type ListVhostSnapshotPresetResResponseMetadata ¶
type ListVhostSnapshotPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListVhostSnapshotPresetResResponseMetadataError `json:"Error,omitempty"`
}
type ListVhostSnapshotPresetResResult ¶
type ListVhostSnapshotPresetResResult struct {
// 模版列表。
PresetList []*ListVhostSnapshotPresetResResultPresetListItem `json:"PresetList,omitempty"`
}
type ListVhostSnapshotPresetResResultPresetListItem ¶
type ListVhostSnapshotPresetResResultPresetListItem struct {
// REQUIRED; 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
App string `json:"App"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
// 截图模板名称。
SlicePreset *ListVhostSnapshotPresetResResultPresetListItemSlicePreset `json:"SlicePreset,omitempty"`
}
type ListVhostSnapshotPresetResResultPresetListItemSlicePreset ¶
type ListVhostSnapshotPresetResResultPresetListItemSlicePreset struct {
// 截图在 ToS 中的存储位置。
Bucket *string `json:"Bucket,omitempty"`
// 回调信息。
CallbackDetail *Components1Hkcrc4SchemasListvhostsnapshotpresetresPropertiesResultPropertiesPresetlistItemsPropertiesSlicepresetPropertiesCallbackdetail `json:"CallbackDetail,omitempty"`
// 截图间隔时间。
Interval *int32 `json:"Interval,omitempty"`
// 截图模版名称。
Preset *string `json:"Preset,omitempty"`
// veImageX 的服务 ID。
ServiceID *string `json:"ServiceID,omitempty"`
// 截图模版状态。
// * 1:开启
// * 0:关闭
Status *int32 `json:"Status,omitempty"`
}
ListVhostSnapshotPresetResResultPresetListItemSlicePreset - 截图模板名称。
type ListVhostSubtitleTranscodePreset ¶ added in v1.0.32
type ListVhostSubtitleTranscodePreset struct{}
type ListVhostSubtitleTranscodePresetBody ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetBody struct {
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type ListVhostSubtitleTranscodePresetQuery ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetQuery struct{}
type ListVhostSubtitleTranscodePresetReq ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetReq struct {
*ListVhostSubtitleTranscodePresetQuery
*ListVhostSubtitleTranscodePresetBody
}
type ListVhostSubtitleTranscodePresetRes ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetRes struct {
// REQUIRED
ResponseMetadata ListVhostSubtitleTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result ListVhostSubtitleTranscodePresetResResult `json:"Result"`
}
type ListVhostSubtitleTranscodePresetResResponseMetadata ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetResResult ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetResResult struct {
// REQUIRED; 字幕配置列表。
PresetList []ListVhostSubtitleTranscodePresetResResultPresetListItem `json:"PresetList"`
}
type ListVhostSubtitleTranscodePresetResResultPresetListItem ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetResResultPresetListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED
Stream string `json:"Stream"`
// REQUIRED; 转码后缀标识。
Suffixes []string `json:"Suffixes"`
// REQUIRED; 字幕配置详细参数。
TranscodePreset ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePreset `json:"TranscodePreset"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
}
type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePreset ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePreset struct {
// REQUIRED
CreatedAt int32 `json:"CreatedAt"`
// REQUIRED
Delay int32 `json:"Delay"`
// REQUIRED; 字幕配置的描述信息。
Description string `json:"Description"`
// REQUIRED; 预设配置,使用预设配置是系统将自动对字体大小、字幕行数、每行最大字符数和边距参数(MarginVertical 和 MarginHorizontal)进行智能化适配。默认为空,表示不使用预设配置,支持的预设配置如下所示。
// * small :小字幕。
// * medium:中字幕。
// * large:大字幕。 :::tip 使用预设配置时,字幕行数、每行最大字符数、左右边距和底部边距参数不生效,系统将使用预设配置自动进行计算。 :::
DisplayPreset string `json:"DisplayPreset"`
// REQUIRED; 原文翻译成译文时使用的热词词库。
GlossaryWordList []string `json:"GlossaryWordList"`
// REQUIRED; 原文字幕识别时使用的热词词库。
HotWordList []string `json:"HotWordList"`
// REQUIRED; 设置在 16:9 分辨率场景下,每行字幕展示的最大字符数。 :::tip
// * 使用预设配置时,字幕每行最大字符数设置不生效。
// * 不使用预设配置时,字幕每行最大字符数必填。
// * 每个文字、字母、符号或数字均为一个字符。
// * 当屏幕分辨率改变时,屏幕上显示的每行文字数量会相应调整,以适应新的分辨率,确保文字的显示效果和阅读体验。 :::
MaxCharNumber int32 `json:"MaxCharNumber"`
// REQUIRED; 字幕展示的行数,同时适用于原文字幕和译文字幕,支持的取值及含义如下所示。
// * 0:(默认值)根据字幕字数自动进行分行展示;
// * 1:每种字幕展示一行;
// * 2:每种字幕展示两行。 :::tip
// * 使用预设配置时,字幕行数为自动分行展示。
// * 超出行内字数限制时表示字幕将超过显示范围,此时字幕内容将被截断。 :::
MaxRowNumber int32 `json:"MaxRowNumber"`
// REQUIRED; 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。
// :::tip
// * 使用预设配置时,字幕位置设置不生效。
// * 不使用预设配置时,字幕位置设置必填。 :::
Position ComponentsJ1MbxoSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesPosition `json:"Position"`
// REQUIRED; 字幕配置的名称。
PresetName string `json:"PresetName"`
// REQUIRED; 原文字幕展示参数配置。
SourceLanguage Components1523StvSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesSourcelanguage `json:"SourceLanguage"`
// REQUIRED
Status int32 `json:"Status"`
// REQUIRED
SuffixName string `json:"SuffixName"`
// REQUIRED; 译文字幕展示参数配置列表。
TargetLanguage []Components1C398ShSchemasListvhostsubtitletranscodepresetresPropertiesResultPropertiesPresetlistItemsPropertiesTranscodepresetPropertiesTargetlanguageItems `json:"TargetLanguage"`
// REQUIRED
UpdatedAt int32 `json:"UpdatedAt"`
}
ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePreset - 字幕配置详细参数。
type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePresetTargetLanguageItemBorder ¶ added in v1.0.32
type ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePresetTargetLanguageItemBorder struct {
// REQUIRED
Color string `json:"Color"`
// REQUIRED
Width int32 `json:"Width"`
}
ListVhostSubtitleTranscodePresetResResultPresetListItemTranscodePresetTargetLanguageItemBorder - 译文字幕的字体描边配置。
type ListVhostTransCodePreset ¶
type ListVhostTransCodePreset struct{}
type ListVhostTransCodePresetBody ¶
type ListVhostTransCodePresetBody struct {
// REQUIRED; 是否是hls abr 请求
IsHlsAbr bool `json:"IsHlsAbr"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理
// [https://console.volcengine.com/live/main/domain/list]页面,查看需要录制的直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type ListVhostTransCodePresetQuery ¶
type ListVhostTransCodePresetQuery struct{}
type ListVhostTransCodePresetReq ¶
type ListVhostTransCodePresetReq struct {
*ListVhostTransCodePresetQuery
*ListVhostTransCodePresetBody
}
type ListVhostTransCodePresetRes ¶
type ListVhostTransCodePresetRes struct {
// REQUIRED
ResponseMetadata ListVhostTransCodePresetResResponseMetadata `json:"ResponseMetadata"`
Result *ListVhostTransCodePresetResResult `json:"Result,omitempty"`
}
type ListVhostTransCodePresetResResponseMetadata ¶
type ListVhostTransCodePresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListVhostTransCodePresetResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type ListVhostTransCodePresetResResult ¶
type ListVhostTransCodePresetResResult struct {
// REQUIRED; 全部转码配置列表。
AllPresetList []ListVhostTransCodePresetResResultAllPresetListItem `json:"AllPresetList"`
// REQUIRED; 使用内置参数的转码配置列表。
CommonPresetList []ListVhostTransCodePresetResResultCommonPresetListItem `json:"CommonPresetList"`
// REQUIRED; 使用自定义配置的转码配置列表。
CustomizePresetList []ListVhostTransCodePresetResResultCustomizePresetListItem `json:"CustomizePresetList"`
}
type ListVhostTransCodePresetResResultAllPresetListItem ¶
type ListVhostTransCodePresetResResultAllPresetListItem struct {
// REQUIRED; 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
App string `json:"App"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// 转码配置具体信息。
TranscodePreset *ListVhostTransCodePresetResResultAllPresetListItemTranscodePreset `json:"TranscodePreset,omitempty"`
}
type ListVhostTransCodePresetResResultAllPresetListItemTranscodePreset ¶
type ListVhostTransCodePresetResResultAllPresetListItemTranscodePreset struct {
// 音频编码格式。包括以下 3 种类型。
// * aac:使用 aac 编码格式;
// * copy:不进行转码,所有音频编码参数不生效;
// * opus:使用 opus 编码格式。
Acodec *string `json:"Acodec,omitempty"`
// 宽高自适应模式开关。
// * 0:关闭宽高自适应,按照Width和Height的取值进行拉伸;
// * 1:开启宽高自适应,按照ShortSide或LongSide等比缩放。
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
// 是否开启转码不超过源流分辨率。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
// 是否开启不超过源流码率。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
// 是否开启不超过源流帧率。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
// 2 个参考帧之间的最大 B 帧数。BFrames取 0 时,表示去 B 帧。
BFrames *int32 `json:"BFrames,omitempty"`
// 动态范围,画质增强类型生效
// * SDR:输出为SDR
// * HDR:输出为HDR
DynamicRange *string `json:"DynamicRange,omitempty"`
// 是否开启智能插帧,只对画质增强类型生效
// * 0:不开启
// * 1:开启
FISwitch *int64 `json:"FISwitch,omitempty"`
// 视频帧率,单位为 fps,帧率越大,画面越流畅。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔,单位为 s。
GOP *int32 `json:"GOP,omitempty"`
// 视频高度。
Height *int32 `json:"Height,omitempty"`
// 长边长度。 :::tip 当As的取值为 1 时,如果LongSide和ShortSide都取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
// 转码模板参数的类型
// * va:表示使用画质增强
ParamType *string `json:"ParamType,omitempty"`
// 转码配置名称。
Preset *string `json:"Preset,omitempty"`
// 是否极智超清转码。
// * true:极智超清;
// * false:标准转码。
Roi *bool `json:"Roi,omitempty"`
// 使用场景,画质增强时生效 football:足球场景
SceneType *string `json:"SceneType,omitempty"`
// 短边长度。 :::tip 当As的取值为 1 时,如果LongSide和ShortSide都取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
// 转码停止时长,支持触发方式为拉流转码时设置,表示断开拉流后转码停止的时长,单位为 s,取值范围为 [0,300],-1 表示不停止转码,默认值为 60。
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码流后缀名。
SuffixName *string `json:"SuffixName,omitempty"`
// 转码触发方式,默认为拉流转码,支持以下取值。
// * Push:推流转码,直播推流后会自动启动转码任务,生成转码流;
// * Pull:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。
TransType *string `json:"TransType,omitempty"`
// 视频编码格式。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式;
// * h266:使用 H.266 编码格式;
// * copy:不进行转码,所有视频编码参数不生效。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 kbps。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
// 视频宽度。
Width *int32 `json:"Width,omitempty"`
}
ListVhostTransCodePresetResResultAllPresetListItemTranscodePreset - 转码配置具体信息。
type ListVhostTransCodePresetResResultCommonPresetListItem ¶
type ListVhostTransCodePresetResResultCommonPresetListItem struct {
// REQUIRED; 应用名称。
App string `json:"App"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// 转码配置具体信息。
TranscodePreset *ListVhostTransCodePresetResResultCommonPresetListItemTranscodePreset `json:"TranscodePreset,omitempty"`
}
type ListVhostTransCodePresetResResultCommonPresetListItemTranscodePreset ¶
type ListVhostTransCodePresetResResultCommonPresetListItemTranscodePreset struct {
// 音频编码格式,默认值为 aac,支持的取值及含义如下所示。
// * aac:使用 AAC 音频编码格式;
// * opus:使用 Opus 音频编码格式。
// * copy:不进行音频转码,所有音频编码参数不生效,音频编码参数包括音频码率(AudioBitrate)等。
Acodec *string `json:"Acodec,omitempty"`
// 视频分辨率自适应模式开关,默认值为 0。支持的取值及含义如下。
// * 0:关闭视频分辨率自适应;
// * 1:开启视频分辨率自适应。 :::tip
// * 关闭视频分辨率自适应模式(As 取值为 0)时,转码配置的视频分辨率取视频宽度(Width)和视频高度(Height)的值对转码视频进行拉伸;
// * 开启视频分辨率自适应模式(As 取值为 1)时,转码配置的视频分辨率按照短边长度(ShortSide)、长边长度(LongSide)、视频宽度(Width)、视频高度(Height)的优先级取值,另一边等比缩放。 :::
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
// 是否开启转码视频分辨率不超过源流分辨率,默认值为 1 表示开启。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
// 是否开启转码视频码率不超过源流码率,默认值为 1 表示开启。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
// 是否开启转码视频帧率不超过源流帧率,默认值为 1 表示开启。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
// 转码输出视频中 2 个参考帧之间的最大 B 帧数量,取值为 0 时表示去除 B 帧。
BFrames *int32 `json:"BFrames,omitempty"`
// 视频帧率,单位为 fps,帧率越大,画面越流畅。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔,单位为秒。
GOP *int32 `json:"GOP,omitempty"`
// 视频高度。
// :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Height *int32 `json:"Height,omitempty"`
// 长边长度。
// :::tip
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,参数生效,反之则不生效。
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
// 转码配置名称。
Preset *string `json:"Preset,omitempty"`
// 转码类型是否为极智超清转码,默认值为 false,取值及含义如下。
// * true:极智超清转码;
// * false:标准转码。
// :::tip 视频编码格式为 H.266 (Vcodec取值为h266)时,转码类型不支持极智超清转码。 :::
Roi *bool `json:"Roi,omitempty"`
// 短边长度。 :::tip
// * 当 As 的取值为 1 即开启宽高自适应时,参数生效,反之则不生效。
// * 当 As 的取值为 1 时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
// 转码停止时长,支持触发方式为拉流转码(TransType 取值为 Pull)时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 -1 和 [0,300],-1 表示不停止转码,默认值为 60。
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码流后缀名。
SuffixName *string `json:"SuffixName,omitempty"`
// 转码触发方式,支持的取值及含义如下。
// * Push:推流转码,直播推流后会自动启动转码任务,生成转码流;
// * Pull:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。
TransType *string `json:"TransType,omitempty"`
// 视频编码格式,支持的取值及含义如下所示。
// * h264:使用 H.264 视频编码格式;
// * h265:使用 H.265 视频编码格式;
// * h266:使用 H.266 视频编码格式;
// * copy:不进行视频转码,所有视频编码参数不生效,视频编码参数包括视频帧率(FPS)、视频码率(VideoBitrate)、分辨率设置(As、Width、Height、ShortSide、LongSide)、GOP 和 BFrames
// 等。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 kbps。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
// 视频宽度。 :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Width *int32 `json:"Width,omitempty"`
}
ListVhostTransCodePresetResResultCommonPresetListItemTranscodePreset - 转码配置具体信息。
type ListVhostTransCodePresetResResultCustomizePresetListItem ¶
type ListVhostTransCodePresetResResultCustomizePresetListItem struct {
// REQUIRED; 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
App string `json:"App"`
// REQUIRED; 域名空间。
Vhost string `json:"Vhost"`
// 转码配置具体信息。
TranscodePreset *ListVhostTransCodePresetResResultCustomizePresetListItemTranscodePreset `json:"TranscodePreset,omitempty"`
}
type ListVhostTransCodePresetResResultCustomizePresetListItemTranscodePreset ¶
type ListVhostTransCodePresetResResultCustomizePresetListItemTranscodePreset struct {
// 音频编码格式。包括以下 3 种类型。
// * aac:使用 aac 编码格式;
// * copy:不进行转码,所有音频编码参数不生效;
// * opus:使用 opus 编码格式。
Acodec *string `json:"Acodec,omitempty"`
// 宽高自适应模式开关。
// * 0:关闭宽高自适应,按照Width和Height的取值进行拉伸;
// * 1:开启宽高自适应,按照ShortSide或LongSide等比缩放。
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
// 是否开启转码不超过源流分辨率。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
// 是否开启不超过源流码率。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
// 是否开启不超过源流帧率。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码,默认开启。
// * 0:关闭
// * 1:开启
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
// 2 个参考帧之间的最大 B 帧数。BFrames取 0 时,表示去 B 帧。
BFrames *int32 `json:"BFrames,omitempty"`
// 动态范围,画质增强类型生效
// * SDR:输出为SDR
// * HDR:输出为HDR
DynamicRange *string `json:"DynamicRange,omitempty"`
// 是否开启智能插帧,只对画质增强类型生效
// * 0:不开启
// * 1:开启
FISwitch *int64 `json:"FISwitch,omitempty"`
// 视频帧率,单位为 fps,帧率越大,画面越流畅。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔,单位为 s。
GOP *int32 `json:"GOP,omitempty"`
// 视频高度。
Height *int32 `json:"Height,omitempty"`
// 长边长度。 :::tip 当As的取值为 1 时,如果LongSide和ShortSide都取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
// 转码模板参数的类型
// * va:表示使用画质增强
ParamType *string `json:"ParamType,omitempty"`
// 转码配置名称。
Preset *string `json:"Preset,omitempty"`
// 是否极智超清转码。
// * true:极智超清;
// * false:标准转码。
Roi *bool `json:"Roi,omitempty"`
// 使用场景,画质增强时生效 football:足球场景
SceneType *string `json:"SceneType,omitempty"`
// 短边长度。 :::tip 当As的取值为 1 时,如果LongSide和ShortSide都取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
// 转码停止时长,支持触发方式为拉流转码时设置,表示断开拉流后转码停止的时长,单位为 s,取值范围为 [0,300],-1 表示不停止转码,默认值为 60。
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码流后缀名。
SuffixName *string `json:"SuffixName,omitempty"`
Threads *int32 `json:"Threads,omitempty"`
// 转码触发方式,默认为拉流转码,支持以下取值。
// * Push:推流转码,直播推流后会自动启动转码任务,生成转码流;
// * Pull:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。
TransType *string `json:"TransType,omitempty"`
// 视频编码格式。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式;
// * h266:使用 H.266 编码格式;
// * copy:不进行转码,所有视频编码参数不生效。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 kbps。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
// 视频宽度。
Width *int32 `json:"Width,omitempty"`
}
ListVhostTransCodePresetResResultCustomizePresetListItemTranscodePreset - 转码配置具体信息。
type ListVhostWatermarkPreset ¶
type ListVhostWatermarkPreset struct{}
type ListVhostWatermarkPresetBody ¶
type ListVhostWatermarkPresetBody struct {
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type ListVhostWatermarkPresetQuery ¶
type ListVhostWatermarkPresetQuery struct{}
type ListVhostWatermarkPresetReq ¶
type ListVhostWatermarkPresetReq struct {
*ListVhostWatermarkPresetQuery
*ListVhostWatermarkPresetBody
}
type ListVhostWatermarkPresetRes ¶
type ListVhostWatermarkPresetRes struct {
// REQUIRED
ResponseMetadata ListVhostWatermarkPresetResResponseMetadata `json:"ResponseMetadata"`
Result *ListVhostWatermarkPresetResResult `json:"Result,omitempty"`
}
type ListVhostWatermarkPresetResResponseMetadata ¶
type ListVhostWatermarkPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListVhostWatermarkPresetResResponseMetadataError `json:"Error,omitempty"`
}
type ListVhostWatermarkPresetResResult ¶
type ListVhostWatermarkPresetResResult struct {
// 统计消息,提供可用配置和不可用配置的数量。
StaticsMsg *string `json:"StaticsMsg,omitempty"`
// 不可正常使用的水印配置列表,如水印图片获取失败等原因导致的配置不可用。返回不可正常使用的水印配置信息及配置不可用的原因。
WatermarkErrMsgList []*ListVhostWatermarkPresetResResultWatermarkErrMsgListItem `json:"WatermarkErrMsgList,omitempty"`
// 可正常使用的水印配置列表。
WatermarkPresetList []*ListVhostWatermarkPresetResResultWatermarkPresetListItem `json:"WatermarkPresetList,omitempty"`
}
type ListVhostWatermarkPresetResResultWatermarkPresetListItem ¶
type ListVhostWatermarkPresetResResultWatermarkPresetListItem struct {
// 火山引擎账号 ID。
AccountID *string `json:"AccountID,omitempty"`
// 应用名称。
App *string `json:"App,omitempty"`
// 水印模版 ID。
ID *int32 `json:"ID,omitempty"`
// 需要添加水印的直播画面方向。
// * vertical:竖屏;
// * horizontal:横屏。
Orientation *string `json:"Orientation,omitempty"`
// 水印图片编码字符串。
Picture *string `json:"Picture,omitempty"`
// 水印图片文件名。
PictureKey *string `json:"PictureKey,omitempty"`
// 水印图片对应的 HTTP 地址。与水印图片字符串字段二选一传入,同时传入时,以水印图片字符串参数为准。
PictureURL *string `json:"PictureURL,omitempty"`
// 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。
PosX *float32 `json:"PosX,omitempty"`
// 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。
PosY *float32 `json:"PosY,omitempty"`
// 水印图片预览背景高度,单位为 px。
PreviewHeight *float32 `json:"PreviewHeight,omitempty"`
// 水印图片预览背景宽度,单位为 px。
PreviewWidth *float32 `json:"PreviewWidth,omitempty"`
// 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。
RelativeHeight *float32 `json:"RelativeHeight,omitempty"`
// 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。
RelativeWidth *float32 `json:"RelativeWidth,omitempty"`
// 流名称。
Stream *string `json:"Stream,omitempty"`
// 域名空间。
Vhost *string `json:"Vhost,omitempty"`
}
type ListWatermarkPreset ¶
type ListWatermarkPreset struct{}
type ListWatermarkPresetBody ¶
type ListWatermarkPresetBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 流名称,取值与直播流地址中 StreamName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
// :::tip
// * 默认为空,表示查询的 AppName 级别对所有转码流生效的配置。
// * 指定流名称时,表示查询仅对 AppName 下指定流名称的转码流生效的配置。 :::
Stream *string `json:"Stream,omitempty"`
}
type ListWatermarkPresetQuery ¶
type ListWatermarkPresetQuery struct{}
type ListWatermarkPresetReq ¶
type ListWatermarkPresetReq struct {
*ListWatermarkPresetQuery
*ListWatermarkPresetBody
}
type ListWatermarkPresetRes ¶
type ListWatermarkPresetRes struct {
// REQUIRED
ResponseMetadata ListWatermarkPresetResResponseMetadata `json:"ResponseMetadata"`
Result *ListWatermarkPresetResResult `json:"Result,omitempty"`
}
type ListWatermarkPresetResResponseMetadata ¶
type ListWatermarkPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ListWatermarkPresetResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type ListWatermarkPresetResResult ¶
type ListWatermarkPresetResResult struct {
// REQUIRED; 水印模板。
Preset ListWatermarkPresetResResultPreset `json:"Preset"`
}
type ListWatermarkPresetResResultPreset ¶
type ListWatermarkPresetResResultPreset struct {
// 火山引擎账号 ID。
AccountID *string `json:"AccountID,omitempty"`
// 应用名称。
App *string `json:"App,omitempty"`
// 水印配置的 ID。
ID *int32 `json:"ID,omitempty"`
// 需要添加水印的直播画面方向。
// * vertical:竖屏;
// * horizontal:横屏。
Orientation *string `json:"Orientation,omitempty"`
// 水印图片编码字符串。
Picture *string `json:"Picture,omitempty"`
// 水印图片文件名。
PictureKey *string `json:"PictureKey,omitempty"`
// 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入,同时传入时,以水印图片编码字符串参数为准。
PictureURL *string `json:"PictureURL,omitempty"`
// 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。
PosX *float32 `json:"PosX,omitempty"`
// 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。
PosY *float32 `json:"PosY,omitempty"`
// 水印图片预览背景高度,单位为 px。
PreviewHeight *float32 `json:"PreviewHeight,omitempty"`
// 水印图片预览背景宽度,单位为 px。
PreviewWidth *float32 `json:"PreviewWidth,omitempty"`
// 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。
RelativeHeight *float32 `json:"RelativeHeight,omitempty"`
// 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。
RelativeWidth *float32 `json:"RelativeWidth,omitempty"`
// 流名称。
Stream *string `json:"Stream,omitempty"`
// 域名空间。
Vhost *string `json:"Vhost,omitempty"`
}
ListWatermarkPresetResResultPreset - 水印模板。
type Live ¶
func NewInstance ¶
func NewInstance() *Live
func NewInstanceWithRegion ¶
func (*Live) BindCert ¶
func (c *Live) BindCert(arg *BindCertBody) (*BindCertRes, error)
func (*Live) BindEncryptDRM ¶
func (c *Live) BindEncryptDRM(arg *BindEncryptDRMBody) (*BindEncryptDRMRes, error)
func (*Live) CreateCert ¶
func (c *Live) CreateCert(arg *CreateCertBody) (*CreateCertRes, error)
func (*Live) CreateCloudMixTask ¶ added in v1.0.32
func (c *Live) CreateCloudMixTask(arg *CreateCloudMixTaskBody) (*CreateCloudMixTaskRes, error)
func (*Live) CreateDomainV2 ¶
func (c *Live) CreateDomainV2(arg *CreateDomainV2Body) (*CreateDomainV2Res, error)
func (*Live) CreateLiveVideoQualityAnalysisTask ¶ added in v1.0.32
func (c *Live) CreateLiveVideoQualityAnalysisTask(arg *CreateLiveVideoQualityAnalysisTaskBody) (*CreateLiveVideoQualityAnalysisTaskRes, error)
func (*Live) CreatePullToPushGroup ¶ added in v1.0.32
func (c *Live) CreatePullToPushGroup(arg *CreatePullToPushGroupBody) (*CreatePullToPushGroupRes, error)
func (*Live) CreatePullToPushTask ¶
func (c *Live) CreatePullToPushTask(arg *CreatePullToPushTaskBody) (*CreatePullToPushTaskRes, error)
func (*Live) CreateRecordPresetV2 ¶
func (c *Live) CreateRecordPresetV2(arg *CreateRecordPresetV2Body) (*CreateRecordPresetV2Res, error)
func (*Live) CreateSnapshotPreset ¶
func (c *Live) CreateSnapshotPreset(arg *CreateSnapshotPresetBody) (*CreateSnapshotPresetRes, error)
func (*Live) CreateSubtitleTranscodePreset ¶ added in v1.0.32
func (c *Live) CreateSubtitleTranscodePreset(arg *CreateSubtitleTranscodePresetBody) (*CreateSubtitleTranscodePresetRes, error)
func (*Live) CreateTimeShiftPresetV2 ¶
func (c *Live) CreateTimeShiftPresetV2(arg *CreateTimeShiftPresetV2Body) (*CreateTimeShiftPresetV2Res, error)
func (*Live) CreateTranscodePreset ¶
func (c *Live) CreateTranscodePreset(arg *CreateTranscodePresetBody) (*CreateTranscodePresetRes, error)
func (*Live) CreateWatermarkPreset ¶
func (c *Live) CreateWatermarkPreset(arg *CreateWatermarkPresetBody) (*CreateWatermarkPresetRes, error)
func (*Live) DeleteCMAFConfig ¶
func (c *Live) DeleteCMAFConfig(arg *DeleteCMAFConfigBody) (*DeleteCMAFConfigRes, error)
func (*Live) DeleteCallback ¶
func (c *Live) DeleteCallback(arg *DeleteCallbackBody) (*DeleteCallbackRes, error)
func (*Live) DeleteCert ¶
func (c *Live) DeleteCert(arg *DeleteCertBody) (*DeleteCertRes, error)
func (*Live) DeleteCloudMixTask ¶ added in v1.0.32
func (c *Live) DeleteCloudMixTask(arg *DeleteCloudMixTaskBody) (*DeleteCloudMixTaskRes, error)
func (*Live) DeleteClusterRateLimit ¶ added in v1.0.28
func (c *Live) DeleteClusterRateLimit(arg *DeleteClusterRateLimitBody) (*DeleteClusterRateLimitRes, error)
func (*Live) DeleteDomain ¶
func (c *Live) DeleteDomain(arg *DeleteDomainBody) (*DeleteDomainRes, error)
func (*Live) DeleteFormatAccessRule ¶ added in v1.0.28
func (c *Live) DeleteFormatAccessRule(arg *DeleteFormatAccessRuleBody) (*DeleteFormatAccessRuleRes, error)
func (*Live) DeleteHLSConfig ¶
func (c *Live) DeleteHLSConfig(arg *DeleteHLSConfigBody) (*DeleteHLSConfigRes, error)
func (*Live) DeleteHTTPHeaderConfig ¶
func (c *Live) DeleteHTTPHeaderConfig(arg *DeleteHTTPHeaderConfigBody) (*DeleteHTTPHeaderConfigRes, error)
func (*Live) DeleteIPAccessRule ¶
func (c *Live) DeleteIPAccessRule(arg *DeleteIPAccessRuleBody) (*DeleteIPAccessRuleRes, error)
func (*Live) DeleteLatencyConfig ¶
func (c *Live) DeleteLatencyConfig(arg *DeleteLatencyConfigBody) (*DeleteLatencyConfigRes, error)
func (*Live) DeleteLiveVideoQualityAnalysisTask ¶ added in v1.0.32
func (c *Live) DeleteLiveVideoQualityAnalysisTask(arg *DeleteLiveVideoQualityAnalysisTaskBody) (*DeleteLiveVideoQualityAnalysisTaskRes, error)
func (*Live) DeletePullToPushGroup ¶ added in v1.0.32
func (c *Live) DeletePullToPushGroup(arg *DeletePullToPushGroupBody) (*DeletePullToPushGroupRes, error)
func (*Live) DeletePullToPushTask ¶
func (c *Live) DeletePullToPushTask(arg *DeletePullToPushTaskBody) (*DeletePullToPushTaskRes, error)
func (*Live) DeleteRecordPreset ¶
func (c *Live) DeleteRecordPreset(arg *DeleteRecordPresetBody) (*DeleteRecordPresetRes, error)
func (*Live) DeleteReferer ¶
func (c *Live) DeleteReferer(arg *DeleteRefererBody) (*DeleteRefererRes, error)
func (*Live) DeleteRegionAccessRule ¶ added in v1.0.28
func (c *Live) DeleteRegionAccessRule(arg *DeleteRegionAccessRuleBody) (*DeleteRegionAccessRuleRes, error)
func (*Live) DeleteRelaySourceRewrite ¶
func (c *Live) DeleteRelaySourceRewrite(arg *DeleteRelaySourceRewriteBody) (*DeleteRelaySourceRewriteRes, error)
func (*Live) DeleteRelaySourceV3 ¶
func (c *Live) DeleteRelaySourceV3(arg *DeleteRelaySourceV3Body) (*DeleteRelaySourceV3Res, error)
func (*Live) DeleteSnapshotPreset ¶
func (c *Live) DeleteSnapshotPreset(arg *DeleteSnapshotPresetBody) (*DeleteSnapshotPresetRes, error)
func (*Live) DeleteSubtitleTranscodePreset ¶ added in v1.0.32
func (c *Live) DeleteSubtitleTranscodePreset(arg *DeleteSubtitleTranscodePresetBody) (*DeleteSubtitleTranscodePresetRes, error)
func (*Live) DeleteTimeShiftPresetV2 ¶
func (c *Live) DeleteTimeShiftPresetV2(arg *DeleteTimeShiftPresetV2Body) (*DeleteTimeShiftPresetV2Res, error)
func (*Live) DeleteTranscodePreset ¶
func (c *Live) DeleteTranscodePreset(arg *DeleteTranscodePresetBody) (*DeleteTranscodePresetRes, error)
func (*Live) DeleteUserAgentAccessRule ¶ added in v1.0.28
func (c *Live) DeleteUserAgentAccessRule(arg *DeleteUserAgentAccessRuleBody) (*DeleteUserAgentAccessRuleRes, error)
func (*Live) DeleteWatermarkPreset ¶
func (c *Live) DeleteWatermarkPreset(arg *DeleteWatermarkPresetBody) (*DeleteWatermarkPresetRes, error)
func (*Live) DescribeAuth ¶
func (c *Live) DescribeAuth(arg *DescribeAuthBody) (*DescribeAuthRes, error)
func (*Live) DescribeCDNSnapshotHistory ¶
func (c *Live) DescribeCDNSnapshotHistory(arg *DescribeCDNSnapshotHistoryBody) (*DescribeCDNSnapshotHistoryRes, error)
func (*Live) DescribeCMAFConfig ¶
func (c *Live) DescribeCMAFConfig(arg *DescribeCMAFConfigBody) (*DescribeCMAFConfigRes, error)
func (*Live) DescribeCallback ¶
func (c *Live) DescribeCallback(arg *DescribeCallbackBody) (*DescribeCallbackRes, error)
func (*Live) DescribeCertDRM ¶
func (c *Live) DescribeCertDRM(arg *DescribeCertDRMQuery) (*DescribeCertDRMRes, error)
func (*Live) DescribeCertDetailSecretV2 ¶
func (c *Live) DescribeCertDetailSecretV2(arg *DescribeCertDetailSecretV2Body) (*DescribeCertDetailSecretV2Res, error)
func (*Live) DescribeClosedStreamInfoByPage ¶
func (c *Live) DescribeClosedStreamInfoByPage(arg *DescribeClosedStreamInfoByPageQuery) (*DescribeClosedStreamInfoByPageRes, error)
func (*Live) DescribeClusterRateLimit ¶ added in v1.0.28
func (c *Live) DescribeClusterRateLimit(arg *DescribeClusterRateLimitBody) (*DescribeClusterRateLimitRes, error)
func (*Live) DescribeDomain ¶
func (c *Live) DescribeDomain(arg *DescribeDomainBody) (*DescribeDomainRes, error)
func (*Live) DescribeEncryptDRM ¶
func (c *Live) DescribeEncryptDRM() (*DescribeEncryptDRMRes, error)
func (*Live) DescribeEncryptHLS ¶ added in v1.0.32
func (c *Live) DescribeEncryptHLS() (*DescribeEncryptHLSRes, error)
func (*Live) DescribeForbiddenStreamInfoByPage ¶
func (c *Live) DescribeForbiddenStreamInfoByPage(arg *DescribeForbiddenStreamInfoByPageQuery) (*DescribeForbiddenStreamInfoByPageRes, error)
func (*Live) DescribeFormatAccessRule ¶ added in v1.0.28
func (c *Live) DescribeFormatAccessRule(arg *DescribeFormatAccessRuleBody) (*DescribeFormatAccessRuleRes, error)
func (*Live) DescribeHLSConfig ¶
func (c *Live) DescribeHLSConfig(arg *DescribeHLSConfigBody) (*DescribeHLSConfigRes, error)
func (*Live) DescribeHTTPHeaderConfig ¶
func (c *Live) DescribeHTTPHeaderConfig(arg *DescribeHTTPHeaderConfigBody) (*DescribeHTTPHeaderConfigRes, error)
func (*Live) DescribeIPAccessRule ¶
func (c *Live) DescribeIPAccessRule(arg *DescribeIPAccessRuleBody) (*DescribeIPAccessRuleRes, error)
func (*Live) DescribeLatencyConfig ¶
func (c *Live) DescribeLatencyConfig(arg *DescribeLatencyConfigBody) (*DescribeLatencyConfigRes, error)
func (*Live) DescribeLicenseDRM ¶
func (c *Live) DescribeLicenseDRM(arg *DescribeLicenseDRMQuery) (*DescribeLicenseDRMRes, error)
func (*Live) DescribeLiveASRDurationData ¶ added in v1.0.28
func (c *Live) DescribeLiveASRDurationData(arg *DescribeLiveASRDurationDataBody) (*DescribeLiveASRDurationDataRes, error)
func (*Live) DescribeLiveBandwidthData ¶
func (c *Live) DescribeLiveBandwidthData(arg *DescribeLiveBandwidthDataBody) (*DescribeLiveBandwidthDataRes, error)
func (*Live) DescribeLiveBatchPushStreamMetrics ¶
func (c *Live) DescribeLiveBatchPushStreamMetrics(arg *DescribeLiveBatchPushStreamMetricsBody) (*DescribeLiveBatchPushStreamMetricsRes, error)
func (*Live) DescribeLiveISPData ¶
func (c *Live) DescribeLiveISPData() (*DescribeLiveISPDataRes, error)
func (*Live) DescribeLiveLogData ¶
func (c *Live) DescribeLiveLogData(arg *DescribeLiveLogDataBody) (*DescribeLiveLogDataRes, error)
func (*Live) DescribeLiveMetricBandwidthData ¶
func (c *Live) DescribeLiveMetricBandwidthData(arg *DescribeLiveMetricBandwidthDataBody) (*DescribeLiveMetricBandwidthDataRes, error)
func (*Live) DescribeLiveMetricTrafficData ¶
func (c *Live) DescribeLiveMetricTrafficData(arg *DescribeLiveMetricTrafficDataBody) (*DescribeLiveMetricTrafficDataRes, error)
func (*Live) DescribeLiveP95PeakBandwidthData ¶
func (c *Live) DescribeLiveP95PeakBandwidthData(arg *DescribeLiveP95PeakBandwidthDataBody) (*DescribeLiveP95PeakBandwidthDataRes, error)
func (*Live) DescribeLivePlayStatusCodeData ¶
func (c *Live) DescribeLivePlayStatusCodeData(arg *DescribeLivePlayStatusCodeDataBody) (*DescribeLivePlayStatusCodeDataRes, error)
func (*Live) DescribeLivePullToPushBandwidthData ¶
func (c *Live) DescribeLivePullToPushBandwidthData(arg *DescribeLivePullToPushBandwidthDataBody) (*DescribeLivePullToPushBandwidthDataRes, error)
func (*Live) DescribeLivePullToPushData ¶
func (c *Live) DescribeLivePullToPushData(arg *DescribeLivePullToPushDataBody) (*DescribeLivePullToPushDataRes, error)
func (*Live) DescribeLivePushStreamInfoData ¶ added in v1.0.28
func (c *Live) DescribeLivePushStreamInfoData(arg *DescribeLivePushStreamInfoDataBody) (*DescribeLivePushStreamInfoDataRes, error)
func (*Live) DescribeLivePushStreamMetrics ¶
func (c *Live) DescribeLivePushStreamMetrics(arg *DescribeLivePushStreamMetricsBody) (*DescribeLivePushStreamMetricsRes, error)
func (*Live) DescribeLiveRecordData ¶
func (c *Live) DescribeLiveRecordData(arg *DescribeLiveRecordDataBody) (*DescribeLiveRecordDataRes, error)
func (*Live) DescribeLiveRegionData ¶
func (c *Live) DescribeLiveRegionData() (*DescribeLiveRegionDataRes, error)
func (*Live) DescribeLiveSnapshotData ¶
func (c *Live) DescribeLiveSnapshotData(arg *DescribeLiveSnapshotDataBody) (*DescribeLiveSnapshotDataRes, error)
func (*Live) DescribeLiveSourceBandwidthData ¶
func (c *Live) DescribeLiveSourceBandwidthData(arg *DescribeLiveSourceBandwidthDataBody) (*DescribeLiveSourceBandwidthDataRes, error)
func (*Live) DescribeLiveSourceStreamMetrics ¶
func (c *Live) DescribeLiveSourceStreamMetrics(arg *DescribeLiveSourceStreamMetricsBody) (*DescribeLiveSourceStreamMetricsRes, error)
func (*Live) DescribeLiveSourceTrafficData ¶
func (c *Live) DescribeLiveSourceTrafficData(arg *DescribeLiveSourceTrafficDataBody) (*DescribeLiveSourceTrafficDataRes, error)
func (*Live) DescribeLiveStorageSpaceData ¶ added in v1.0.28
func (c *Live) DescribeLiveStorageSpaceData(arg *DescribeLiveStorageSpaceDataBody) (*DescribeLiveStorageSpaceDataRes, error)
func (*Live) DescribeLiveStreamInfoByPage ¶
func (c *Live) DescribeLiveStreamInfoByPage(arg *DescribeLiveStreamInfoByPageQuery) (*DescribeLiveStreamInfoByPageRes, error)
func (*Live) DescribeLiveStreamSessionData ¶
func (c *Live) DescribeLiveStreamSessionData(arg *DescribeLiveStreamSessionDataBody) (*DescribeLiveStreamSessionDataRes, error)
func (*Live) DescribeLiveStreamState ¶
func (c *Live) DescribeLiveStreamState(arg *DescribeLiveStreamStateQuery) (*DescribeLiveStreamStateRes, error)
func (*Live) DescribeLiveTrafficData ¶
func (c *Live) DescribeLiveTrafficData(arg *DescribeLiveTrafficDataBody) (*DescribeLiveTrafficDataRes, error)
func (*Live) DescribeLiveTranscodeData ¶
func (c *Live) DescribeLiveTranscodeData(arg *DescribeLiveTranscodeDataBody) (*DescribeLiveTranscodeDataRes, error)
func (*Live) DescribeLiveTranscodeInfoData ¶ added in v1.0.32
func (c *Live) DescribeLiveTranscodeInfoData(arg *DescribeLiveTranscodeInfoDataBody) (*DescribeLiveTranscodeInfoDataRes, error)
func (*Live) DescribeRecordTaskFileHistory ¶
func (c *Live) DescribeRecordTaskFileHistory(arg *DescribeRecordTaskFileHistoryBody) (*DescribeRecordTaskFileHistoryRes, error)
func (*Live) DescribeReferer ¶
func (c *Live) DescribeReferer(arg *DescribeRefererBody) (*DescribeRefererRes, error)
func (*Live) DescribeRegionAccessRule ¶ added in v1.0.28
func (c *Live) DescribeRegionAccessRule(arg *DescribeRegionAccessRuleBody) (*DescribeRegionAccessRuleRes, error)
func (*Live) DescribeRelaySourceRewrite ¶
func (c *Live) DescribeRelaySourceRewrite(arg *DescribeRelaySourceRewriteBody) (*DescribeRelaySourceRewriteRes, error)
func (*Live) DescribeRelaySourceV3 ¶
func (c *Live) DescribeRelaySourceV3(arg *DescribeRelaySourceV3Body) (*DescribeRelaySourceV3Res, error)
func (*Live) DescribeUserAgentAccessRule ¶ added in v1.0.28
func (c *Live) DescribeUserAgentAccessRule(arg *DescribeUserAgentAccessRuleBody) (*DescribeUserAgentAccessRuleRes, error)
func (*Live) DisableDomain ¶
func (c *Live) DisableDomain(arg *DisableDomainBody) (*DisableDomainRes, error)
func (*Live) EnableDomain ¶
func (c *Live) EnableDomain(arg *EnableDomainBody) (*EnableDomainRes, error)
func (*Live) EnableHTTPHeaderConfig ¶
func (c *Live) EnableHTTPHeaderConfig(arg *EnableHTTPHeaderConfigBody) (*EnableHTTPHeaderConfigRes, error)
func (*Live) ForbidStream ¶
func (c *Live) ForbidStream(arg *ForbidStreamBody) (*ForbidStreamRes, error)
func (*Live) GeneratePlayURL ¶
func (c *Live) GeneratePlayURL(arg *GeneratePlayURLBody) (*GeneratePlayURLRes, error)
func (*Live) GeneratePushURL ¶
func (c *Live) GeneratePushURL(arg *GeneratePushURLBody) (*GeneratePushURLRes, error)
func (*Live) GetCloudMixTaskDetail ¶ added in v1.0.32
func (c *Live) GetCloudMixTaskDetail(arg *GetCloudMixTaskDetailBody) (*GetCloudMixTaskDetailRes, error)
func (*Live) GetHLSEncryptDataKey ¶ added in v1.0.32
func (c *Live) GetHLSEncryptDataKey(arg *GetHLSEncryptDataKeyQuery) (*GetHLSEncryptDataKeyRes, error)
func (*Live) GetLiveVideoQualityAnalysisTaskDetail ¶ added in v1.0.32
func (c *Live) GetLiveVideoQualityAnalysisTaskDetail(arg *GetLiveVideoQualityAnalysisTaskDetailBody) (*GetLiveVideoQualityAnalysisTaskDetailRes, error)
func (*Live) KillStream ¶
func (c *Live) KillStream(arg *KillStreamBody) (*KillStreamRes, error)
func (*Live) ListBindEncryptDRM ¶
func (c *Live) ListBindEncryptDRM(arg *ListBindEncryptDRMBody) (*ListBindEncryptDRMRes, error)
func (*Live) ListCertV2 ¶
func (c *Live) ListCertV2(arg *ListCertV2Body) (*ListCertV2Res, error)
func (*Live) ListCloudMixTask ¶ added in v1.0.32
func (c *Live) ListCloudMixTask(arg *ListCloudMixTaskBody) (*ListCloudMixTaskRes, error)
func (*Live) ListCommonTransPresetDetail ¶
func (c *Live) ListCommonTransPresetDetail(arg *ListCommonTransPresetDetailBody) (*ListCommonTransPresetDetailRes, error)
func (*Live) ListDomainDetail ¶
func (c *Live) ListDomainDetail(arg *ListDomainDetailBody) (*ListDomainDetailRes, error)
func (*Live) ListLiveVideoQualityAnalysisTasks ¶ added in v1.0.32
func (c *Live) ListLiveVideoQualityAnalysisTasks(arg *ListLiveVideoQualityAnalysisTasksBody) (*ListLiveVideoQualityAnalysisTasksRes, error)
func (*Live) ListPullToPushGroup ¶ added in v1.0.32
func (c *Live) ListPullToPushGroup(arg *ListPullToPushGroupBody) (*ListPullToPushGroupRes, error)
func (*Live) ListPullToPushTask ¶
func (c *Live) ListPullToPushTask(arg *ListPullToPushTaskQuery) (*ListPullToPushTaskRes, error)
func (*Live) ListPullToPushTaskV2 ¶ added in v1.0.32
func (c *Live) ListPullToPushTaskV2(arg *ListPullToPushTaskV2Body) (*ListPullToPushTaskV2Res, error)
func (*Live) ListTimeShiftPresetV2 ¶
func (c *Live) ListTimeShiftPresetV2(arg *ListTimeShiftPresetV2Body) (*ListTimeShiftPresetV2Res, error)
func (*Live) ListVhostRecordPresetV2 ¶
func (c *Live) ListVhostRecordPresetV2(arg *ListVhostRecordPresetV2Body) (*ListVhostRecordPresetV2Res, error)
func (*Live) ListVhostSnapshotPreset ¶
func (c *Live) ListVhostSnapshotPreset(arg *ListVhostSnapshotPresetBody) (*ListVhostSnapshotPresetRes, error)
func (*Live) ListVhostSubtitleTranscodePreset ¶ added in v1.0.32
func (c *Live) ListVhostSubtitleTranscodePreset(arg *ListVhostSubtitleTranscodePresetBody) (*ListVhostSubtitleTranscodePresetRes, error)
func (*Live) ListVhostTransCodePreset ¶
func (c *Live) ListVhostTransCodePreset(arg *ListVhostTransCodePresetBody) (*ListVhostTransCodePresetRes, error)
func (*Live) ListVhostWatermarkPreset ¶
func (c *Live) ListVhostWatermarkPreset(arg *ListVhostWatermarkPresetBody) (*ListVhostWatermarkPresetRes, error)
func (*Live) ListWatermarkPreset ¶
func (c *Live) ListWatermarkPreset(arg *ListWatermarkPresetBody) (*ListWatermarkPresetRes, error)
func (*Live) RestartPullToPushTask ¶
func (c *Live) RestartPullToPushTask(arg *RestartPullToPushTaskBody) (*RestartPullToPushTaskRes, error)
func (*Live) ResumeStream ¶
func (c *Live) ResumeStream(arg *ResumeStreamBody) (*ResumeStreamRes, error)
func (*Live) StopPullToPushTask ¶
func (c *Live) StopPullToPushTask(arg *StopPullToPushTaskBody) (*StopPullToPushTaskRes, error)
func (*Live) UnBindEncryptDRM ¶
func (c *Live) UnBindEncryptDRM(arg *UnBindEncryptDRMBody) (*UnBindEncryptDRMRes, error)
func (*Live) UnbindCert ¶
func (c *Live) UnbindCert(arg *UnbindCertBody) (*UnbindCertRes, error)
func (*Live) UpdateAuthKey ¶
func (c *Live) UpdateAuthKey(arg *UpdateAuthKeyBody) (*UpdateAuthKeyRes, error)
func (*Live) UpdateCMAFConfig ¶
func (c *Live) UpdateCMAFConfig(arg *UpdateCMAFConfigBody) (*UpdateCMAFConfigRes, error)
func (*Live) UpdateCallback ¶
func (c *Live) UpdateCallback(arg *UpdateCallbackBody) (*UpdateCallbackRes, error)
func (*Live) UpdateCloudMixTask ¶ added in v1.0.32
func (c *Live) UpdateCloudMixTask(arg *UpdateCloudMixTaskBody) (*UpdateCloudMixTaskRes, error)
func (*Live) UpdateClusterRateLimit ¶ added in v1.0.28
func (c *Live) UpdateClusterRateLimit(arg *UpdateClusterRateLimitBody) (*UpdateClusterRateLimitRes, error)
func (*Live) UpdateDomainVhost ¶
func (c *Live) UpdateDomainVhost(arg *UpdateDomainVhostBody) (*UpdateDomainVhostRes, error)
func (*Live) UpdateEncryptDRM ¶
func (c *Live) UpdateEncryptDRM(arg *UpdateEncryptDRMBody) (*UpdateEncryptDRMRes, error)
func (*Live) UpdateEncryptHLS ¶ added in v1.0.32
func (c *Live) UpdateEncryptHLS(arg *UpdateEncryptHLSBody) (*UpdateEncryptHLSRes, error)
func (*Live) UpdateFormatAccessRule ¶ added in v1.0.28
func (c *Live) UpdateFormatAccessRule(arg *UpdateFormatAccessRuleBody) (*UpdateFormatAccessRuleRes, error)
func (*Live) UpdateHLSConfig ¶
func (c *Live) UpdateHLSConfig(arg *UpdateHLSConfigBody) (*UpdateHLSConfigRes, error)
func (*Live) UpdateHTTPHeaderConfig ¶
func (c *Live) UpdateHTTPHeaderConfig(arg *UpdateHTTPHeaderConfigBody) (*UpdateHTTPHeaderConfigRes, error)
func (*Live) UpdateIPAccessRule ¶
func (c *Live) UpdateIPAccessRule(arg *UpdateIPAccessRuleBody) (*UpdateIPAccessRuleRes, error)
func (*Live) UpdateLatencyConfig ¶
func (c *Live) UpdateLatencyConfig(arg *UpdateLatencyConfigBody) (*UpdateLatencyConfigRes, error)
func (*Live) UpdatePullToPushTask ¶
func (c *Live) UpdatePullToPushTask(arg *UpdatePullToPushTaskBody) (*UpdatePullToPushTaskRes, error)
func (*Live) UpdateRecordPresetV2 ¶
func (c *Live) UpdateRecordPresetV2(arg *UpdateRecordPresetV2Body) (*UpdateRecordPresetV2Res, error)
func (*Live) UpdateReferer ¶
func (c *Live) UpdateReferer(arg *UpdateRefererBody) (*UpdateRefererRes, error)
func (*Live) UpdateRegionAccessRule ¶ added in v1.0.28
func (c *Live) UpdateRegionAccessRule(arg *UpdateRegionAccessRuleBody) (*UpdateRegionAccessRuleRes, error)
func (*Live) UpdateRelaySourceRewrite ¶
func (c *Live) UpdateRelaySourceRewrite(arg *UpdateRelaySourceRewriteBody) (*UpdateRelaySourceRewriteRes, error)
func (*Live) UpdateRelaySourceV3 ¶
func (c *Live) UpdateRelaySourceV3(arg *UpdateRelaySourceV3Body) (*UpdateRelaySourceV3Res, error)
func (*Live) UpdateSnapshotPreset ¶
func (c *Live) UpdateSnapshotPreset(arg *UpdateSnapshotPresetBody) (*UpdateSnapshotPresetRes, error)
func (*Live) UpdateSubtitleTranscodePreset ¶ added in v1.0.32
func (c *Live) UpdateSubtitleTranscodePreset(arg *UpdateSubtitleTranscodePresetBody) (*UpdateSubtitleTranscodePresetRes, error)
func (*Live) UpdateTimeShiftPresetV2 ¶
func (c *Live) UpdateTimeShiftPresetV2(arg *UpdateTimeShiftPresetV2Body) (*UpdateTimeShiftPresetV2Res, error)
func (*Live) UpdateTranscodePreset ¶
func (c *Live) UpdateTranscodePreset(arg *UpdateTranscodePresetBody) (*UpdateTranscodePresetRes, error)
func (*Live) UpdateUserAgentAccessRule ¶ added in v1.0.28
func (c *Live) UpdateUserAgentAccessRule(arg *UpdateUserAgentAccessRuleBody) (*UpdateUserAgentAccessRuleRes, error)
func (*Live) UpdateWatermarkPreset ¶
func (c *Live) UpdateWatermarkPreset(arg *UpdateWatermarkPresetBody) (*UpdateWatermarkPresetRes, error)
type RestartPullToPushTask ¶
type RestartPullToPushTask struct{}
type RestartPullToPushTaskBody ¶
type RestartPullToPushTaskBody struct {
// REQUIRED; 任务 ID,任务的唯一标识,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取状态为停用的任务 ID。
TaskID string `json:"TaskId"`
// 任务所属的群组名称,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。 :::tip
// * 使用主账号调用时,为非必填。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
}
type RestartPullToPushTaskQuery ¶
type RestartPullToPushTaskQuery struct{}
type RestartPullToPushTaskReq ¶
type RestartPullToPushTaskReq struct {
*RestartPullToPushTaskQuery
*RestartPullToPushTaskBody
}
type RestartPullToPushTaskRes ¶
type RestartPullToPushTaskRes struct {
// REQUIRED
ResponseMetadata RestartPullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
}
type RestartPullToPushTaskResResponseMetadata ¶
type RestartPullToPushTaskResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *RestartPullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
}
type ResumeStream ¶
type ResumeStream struct{}
type ResumeStreamBody ¶
type ResumeStreamBody struct {
// REQUIRED; 直播流使用的应用名称。
App string `json:"App"`
// REQUIRED; 直播流使用的流名称。
Stream string `json:"Stream"`
// 直播流使用的域名。 :::tip 参数 Domain 和 Vhost 传且仅传一个。 :::
Domain *string `json:"Domain,omitempty"`
// 域名空间。您可以调用 DescribeForbiddenStreamInfoByPage [https://www.volcengine.com/docs/6469/1126843] 接口,查看禁推直播流的信息,包括 Vhost、Domain、App
// 和 Stream。 :::tip 参数 Domain 和 Vhost 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type ResumeStreamQuery ¶
type ResumeStreamQuery struct{}
type ResumeStreamReq ¶
type ResumeStreamReq struct {
*ResumeStreamQuery
*ResumeStreamBody
}
type ResumeStreamRes ¶
type ResumeStreamRes struct {
// REQUIRED
ResponseMetadata ResumeStreamResResponseMetadata `json:"ResponseMetadata"`
}
type ResumeStreamResResponseMetadata ¶
type ResumeStreamResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *ResumeStreamResResponseMetadataError `json:"Error,omitempty"`
}
type StopPullToPushTask ¶
type StopPullToPushTask struct{}
type StopPullToPushTaskBody ¶
type StopPullToPushTaskBody struct {
// REQUIRED; 任务 ID,任务的唯一标识,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取状态为未开始或生效中的任务 ID。
TaskID string `json:"TaskId"`
// 任务所属的群组名称,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。 :::tip
// * 使用主账号调用时,为非必填。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
}
type StopPullToPushTaskQuery ¶
type StopPullToPushTaskQuery struct{}
type StopPullToPushTaskReq ¶
type StopPullToPushTaskReq struct {
*StopPullToPushTaskQuery
*StopPullToPushTaskBody
}
type StopPullToPushTaskRes ¶
type StopPullToPushTaskRes struct {
// REQUIRED
ResponseMetadata StopPullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
}
type StopPullToPushTaskResResponseMetadata ¶
type StopPullToPushTaskResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *StopPullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
}
type UnBindEncryptDRM ¶
type UnBindEncryptDRM struct{}
type UnBindEncryptDRMBody ¶
type UnBindEncryptDRMBody struct {
// REQUIRED; 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App string `json:"App"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type UnBindEncryptDRMQuery ¶
type UnBindEncryptDRMQuery struct{}
type UnBindEncryptDRMReq ¶
type UnBindEncryptDRMReq struct {
*UnBindEncryptDRMQuery
*UnBindEncryptDRMBody
}
type UnBindEncryptDRMRes ¶
type UnBindEncryptDRMRes struct {
// REQUIRED
ResponseMetadata UnBindEncryptDRMResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UnBindEncryptDRMResResponseMetadata ¶
type UnBindEncryptDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UnbindCert ¶
type UnbindCert struct{}
type UnbindCertBody ¶
type UnbindCertBody struct {
// REQUIRED; 填写需要解绑 HTTPS 证书的域名。 您可以调用 ListDomainDetail [https://www.volcengine.com/docs/6469/1126815] 接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要解绑证书的域名。
Domain string `json:"Domain"`
// REQUIRED; 视频直播服务的配置空间,由 1 到 60 位数字、字母、下划线及"-"和"."组成。 :::tip 参数 Domain 和 Vhost 传且仅传一个。 :::
Vhost string `json:"Vhost"`
}
type UnbindCertQuery ¶
type UnbindCertQuery struct{}
type UnbindCertReq ¶
type UnbindCertReq struct {
*UnbindCertQuery
*UnbindCertBody
}
type UnbindCertRes ¶
type UnbindCertRes struct {
// REQUIRED
ResponseMetadata UnbindCertResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UnbindCertResResponseMetadata ¶
type UnbindCertResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UnbindCertResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateAuthKey ¶
type UpdateAuthKey struct{}
type UpdateAuthKeyBody ¶
type UpdateAuthKeyBody struct {
// REQUIRED; 鉴权配置参数,包括鉴权密钥、鉴权字段、加密字符串生成算法等。
AuthDetailList []UpdateAuthKeyBodyAuthDetailListItem `json:"AuthDetailList"`
// REQUIRED; 鉴权场景类型,取值及含义如下所示。
// * push:推流鉴权;
// * pull:拉流鉴权。
SceneType string `json:"SceneType"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty"`
// 直播流使用的域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名。
// :::tip 参数 Domain 和 Vhost 传且仅传一个。 :::
Domain *string `json:"Domain,omitempty"`
// 是否开启 URL 地址鉴权,取值及含义如下所示。
// * false:关闭(默认值);
// * true:开启。
PushPullEnable *bool `json:"PushPullEnable,omitempty"`
// 鉴权生效时长,单位为秒,默认值为 604800,取值范围为 [60,2592000],超出生效时长后 URL 无法使用。
ValidDuration *int32 `json:"ValidDuration,omitempty"`
// 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的直播流使用的域名所属的域名空间。
// :::tip 参数
// Domain 和 Vhost 传且仅传一个。 :::
Vhost *string `json:"Vhost,omitempty"`
}
type UpdateAuthKeyBodyAuthDetailListItem ¶
type UpdateAuthKeyBodyAuthDetailListItem struct {
// REQUIRED; 推/拉流鉴权时必选
EncryptionAlgorithm string `json:"EncryptionAlgorithm"`
// REQUIRED; 推/拉流鉴权时必选
SecretKey string `json:"SecretKey"`
// 推/拉流鉴权时必选
AuthField map[string]*string `json:"AuthField,omitempty"`
// 推/拉流鉴权时必选
EncryptField []*string `json:"EncryptField,omitempty"`
}
type UpdateAuthKeyQuery ¶
type UpdateAuthKeyQuery struct{}
type UpdateAuthKeyReq ¶
type UpdateAuthKeyReq struct {
*UpdateAuthKeyQuery
*UpdateAuthKeyBody
}
type UpdateAuthKeyRes ¶
type UpdateAuthKeyRes struct {
// REQUIRED
ResponseMetadata UpdateAuthKeyResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateAuthKeyResResponseMetadata ¶
type UpdateAuthKeyResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateAuthKeyResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateCMAFConfig ¶
type UpdateCMAFConfig struct{}
type UpdateCMAFConfigBody ¶
type UpdateCMAFConfigBody struct {
// REQUIRED
Vhost string `json:"Vhost"`
App *string `json:"App,omitempty"`
DefaultLatency *float32 `json:"DefaultLatency,omitempty"`
DisableLowLatency *bool `json:"DisableLowLatency,omitempty"`
Interval *float32 `json:"Interval,omitempty"`
PlaylistLength *int32 `json:"PlaylistLength,omitempty"`
}
type UpdateCMAFConfigQuery ¶
type UpdateCMAFConfigQuery struct{}
type UpdateCMAFConfigReq ¶
type UpdateCMAFConfigReq struct {
*UpdateCMAFConfigQuery
*UpdateCMAFConfigBody
}
type UpdateCMAFConfigRes ¶
type UpdateCMAFConfigRes struct {
// REQUIRED
ResponseMetadata UpdateCMAFConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateCMAFConfigResResponseMetadata ¶
type UpdateCMAFConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateCallback ¶
type UpdateCallback struct{}
type UpdateCallbackBody ¶
type UpdateCallbackBody struct {
// REQUIRED; 回调信息列表。
CallbackDetailList []UpdateCallbackBodyCallbackDetailListItem `json:"CallbackDetailList"`
// REQUIRED; 回调的消息类型,取值及含义如下所示。
// * push:推流开始回调;
// * push_end:推流结束回调;
// * snapshot:截图回调;
// * record:录制任务状态回调;
// * audit_snapshot:截图审核结果回调。
MessageType string `json:"MessageType"`
// domain / app 二选一必传
App *string `json:"App,omitempty"`
// Dictionary of
AppendField map[string]*string `json:"AppendField,omitempty"`
// 回调消息发送是否开启鉴权,默认为 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
AuthEnable *bool `json:"AuthEnable,omitempty"`
// Dictionary of
AuthField map[string]*string `json:"AuthField,omitempty"`
// 回调消息发送鉴权密钥。 :::tip 如果 AuthEnable 为 true,则密钥必填。 :::
AuthKeyPrimary *string `json:"AuthKeyPrimary,omitempty"`
AuthKeySecond *string `json:"AuthKeySecond,omitempty"`
CallbackField []*string `json:"CallbackField,omitempty"`
// 直播流使用的推流域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名。
// :::tipVhost和Domain传且仅传一个。 :::
Domain *string `json:"Domain,omitempty"`
EncryptField []*string `json:"EncryptField,omitempty"`
EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitempty"`
HTTPMethod *string `json:"HttpMethod,omitempty"`
RetryInternalSecond *int32 `json:"RetryInternalSecond,omitempty"`
RetryTimes *int32 `json:"RetryTimes,omitempty"`
SecHandlerType *string `json:"SecHandlerType,omitempty"`
// 任务状态回调开关 0关闭 1开启
TaskStatusCallback *int32 `json:"TaskStatusCallback,omitempty"`
TimeoutSecond *int32 `json:"TimeoutSecond,omitempty"`
// 是否开启转码流回调,默认为 0。取值及含义如下所示。
// * 0:false,不开启;
// * 1:true,开启。
// :::tip 回调类型为推流开始或推流结束时生效。 :::
TranscodeCallback *int32 `json:"TranscodeCallback,omitempty"`
ValidDuration *int32 `json:"ValidDuration,omitempty"`
// domain / app 二选一必传
Vhost *string `json:"Vhost,omitempty"`
}
type UpdateCallbackQuery ¶
type UpdateCallbackQuery struct{}
type UpdateCallbackReq ¶
type UpdateCallbackReq struct {
*UpdateCallbackQuery
*UpdateCallbackBody
}
type UpdateCallbackRes ¶
type UpdateCallbackRes struct {
// REQUIRED
ResponseMetadata UpdateCallbackResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateCallbackResResponseMetadata ¶
type UpdateCallbackResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateCallbackResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateCloudMixTask ¶ added in v1.0.32
type UpdateCloudMixTask struct{}
type UpdateCloudMixTaskBody ¶ added in v1.0.32
type UpdateCloudMixTaskBody struct {
// REQUIRED; 混流任务详细配置。
MixedRules UpdateCloudMixTaskBodyMixedRules `json:"MixedRules"`
// REQUIRED; 混流任务 ID,您可以通过 ListCloudMixTask [https://www.volcengine.com/docs/6469/1271157] 接口获取运行中的混流任务 ID。
TaskID string `json:"TaskID"`
}
type UpdateCloudMixTaskBodyMixedRules ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRules struct {
// REQUIRED; 混流输出布局配置。
InputLayout UpdateCloudMixTaskBodyMixedRulesInputLayout `json:"InputLayout"`
// REQUIRED; 混流素材列表,最多支持配置 8 路输入源。
InputSource []UpdateCloudMixTaskBodyMixedRulesInputSourceItem `json:"InputSource"`
// REQUIRED; 混流输出流参数配置。 :::warning 更新云端混流任务时,Output 参数不支持变更,且必须传入与原混流任务一致的配置。 :::
Output UpdateCloudMixTaskBodyMixedRulesOutput `json:"Output"`
}
UpdateCloudMixTaskBodyMixedRules - 混流任务详细配置。
type UpdateCloudMixTaskBodyMixedRulesInputLayout ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputLayout struct {
// REQUIRED; 混流输出画布配置和素材布局配置。
Scene UpdateCloudMixTaskBodyMixedRulesInputLayoutScene `json:"Scene"`
// 混流输出视频中 Logo 布局配置。 :::tip 支持最多配置 4 个 Logo,展示层级以添加顺序为准。 :::
Logo []*UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItem `json:"Logo,omitempty"`
}
UpdateCloudMixTaskBodyMixedRulesInputLayout - 混流输出布局配置。
type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItem ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItem struct {
// Logo 图片在混流输出整体画面中的布局配置。
Layout *UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout `json:"Layout,omitempty"`
// Logo 图片访问地址。
URL *string `json:"Url,omitempty"`
}
type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout struct {
// REQUIRED
H int32 `json:"H"`
// REQUIRED
W int32 `json:"W"`
// REQUIRED
X int32 `json:"X"`
// REQUIRED
Y int32 `json:"Y"`
}
UpdateCloudMixTaskBodyMixedRulesInputLayoutLogoItemLayout - Logo 图片在混流输出整体画面中的布局配置。
type UpdateCloudMixTaskBodyMixedRulesInputLayoutScene ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputLayoutScene struct {
// REQUIRED; 混流输出整体画布高度,单位为 px,取值范围为 [10,2160]。
Height int32 `json:"Height"`
// REQUIRED; 混流素材在混流输出整体画面中的布局配置。 :::tip 混流素材布局中需包含所有素材的配置,且需与通过 Layer 参数与混流素材一一匹配。 :::
Layout []UpdateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem `json:"Layout"`
// REQUIRED; 混流输出画布整体宽度,单位为 px,取值范围为 [10,2160]。
Width int32 `json:"Width"`
}
UpdateCloudMixTaskBodyMixedRulesInputLayoutScene - 混流输出画布配置和素材布局配置。
type UpdateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputLayoutSceneLayoutItem struct {
// REQUIRED; 当前素材或 Logo 图片在混流输出画面中的限制高度,单位为 px,取值范围为 [10,2160]。
// :::tip 限制宽度和限制高度指定了素材展示的限制范围,当素材尺寸和限制值不一致时,素材将在限制范围内根据长边进行等比缩放,其余区域透明展示。 :::
H int32 `json:"H"`
// REQUIRED; 当配置素材布局时需要通过 Layer 参数与素材进行一一对应。 :::tip 配置 Logo 图片的布局时此参数不生效。 :::
Layer int32 `json:"Layer"`
// REQUIRED; 当前素材或 Logo 图片在混流输出画面中的限制宽度,单位为 px,取值范围为 [10,2160]。
W int32 `json:"W"`
// REQUIRED; 当前素材或 Logo 图片在输出画面中相对画面左上角的 X 偏移位置,单位为 px,取值范围为 0 到设置的画面宽度。
X int32 `json:"X"`
// REQUIRED; 当前素材或 Logo 图片在输出画面中相对画面左上角的 Y 偏移位置,单位为 px,取值范围为 0 到设置的画面高度。
Y int32 `json:"Y"`
}
type UpdateCloudMixTaskBodyMixedRulesInputSourceItem ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesInputSourceItem struct {
// REQUIRED; 混流素材 ID,一个任务中素材 ID 不能重复,此 ID 用于任务状态回调消息中标识素材。
ID string `json:"ID"`
// REQUIRED; 混流素材的叠放顺序,1 为最底层,2 层在 1 层之上,以此类推,取值范围为[1,9999]。 :::tip 当前准备使用某个素材作为布局背景时,其叠放顺序应设置为所有素材中的最小值。 :::
Layer int32 `json:"Layer"`
// REQUIRED; 混流素材类型,支持的取值及含义如下所示。
// * vod:视频点播中的素材,支持 MP4、FLV 格式素材;
// * live:直播源素材,支持 RTMP、FLV 协议拉流地址;
// * pic:图片素材,支持 png、jpg 格式图片。
Type string `json:"Type"`
// REQUIRED; 混流素材访问地址。
URL string `json:"Url"`
}
type UpdateCloudMixTaskBodyMixedRulesOutput ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesOutput struct {
// REQUIRED; 混流声音参数设置。
Audio UpdateCloudMixTaskBodyMixedRulesOutputAudio `json:"Audio"`
// REQUIRED; 混流视频的推流地址。
URL []string `json:"Url"`
// REQUIRED; 混流画面参数设置。
Video UpdateCloudMixTaskBodyMixedRulesOutputVideo `json:"Video"`
}
UpdateCloudMixTaskBodyMixedRulesOutput - 混流输出流参数配置。 :::warning 更新云端混流任务时,Output 参数不支持变更,且必须传入与原混流任务一致的配置。 :::
type UpdateCloudMixTaskBodyMixedRulesOutputAudio ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesOutputAudio struct {
// REQUIRED; 混流输出流的音频码率,单位为 bps,取值范围为 [128000,320000],常见取值及含义如下所示。
// * 128000:128 kbps;
// * 144000:144 kbps;
// * 256000:256 kbps;
// * 320000:320 kbps。
BitRate int32 `json:"BitRate"`
// REQUIRED; 混流输出流的音频声道设置,取值及含义如下所示。
// * mono:单声道;
// * stereo:立体声。
ChannelLayout string `json:"ChannelLayout"`
// REQUIRED; 混流输出流的音频采样率,单位为 HZ,常见取值及含义如下所示。
// * 32000:32 kHZ;
// * 44100:44.1 kHZ;
// * 48000:48 kHZ。
SampleRate int32 `json:"SampleRate"`
}
UpdateCloudMixTaskBodyMixedRulesOutputAudio - 混流声音参数设置。
type UpdateCloudMixTaskBodyMixedRulesOutputVideo ¶ added in v1.0.32
type UpdateCloudMixTaskBodyMixedRulesOutputVideo struct {
// REQUIRED; 混流输出视频码率,单位为 bps,取值范围为 [1000000,20000000],输入值小于或大于取值范围时会进行自动修正至最小值和最大值。
BitRate int32 `json:"BitRate"`
// REQUIRED; 混流输出视频编码格式,支持的取值及含义如下所示。
// * h264:使用 H.264 编码格式;
// * h265:使用 H.265 编码格式。
Codec string `json:"Codec"`
// REQUIRED; 混流输出视频帧率,单位为 fps,取值范围为 [10,60],输入值小于或大于取值范围时会进行自动修正至最小值和最大值。
FrameRate int32 `json:"FrameRate"`
// REQUIRED; IDR 帧之间的最大间隔时间,单位为秒,取值范围为 [1,10]。
GOP int32 `json:"GOP"`
}
UpdateCloudMixTaskBodyMixedRulesOutputVideo - 混流画面参数设置。
type UpdateCloudMixTaskQuery ¶ added in v1.0.32
type UpdateCloudMixTaskQuery struct{}
type UpdateCloudMixTaskReq ¶ added in v1.0.32
type UpdateCloudMixTaskReq struct {
*UpdateCloudMixTaskQuery
*UpdateCloudMixTaskBody
}
type UpdateCloudMixTaskRes ¶ added in v1.0.32
type UpdateCloudMixTaskRes struct {
// REQUIRED
ResponseMetadata UpdateCloudMixTaskResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED
Result UpdateCloudMixTaskResResult `json:"Result"`
}
type UpdateCloudMixTaskResResponseMetadata ¶ added in v1.0.32
type UpdateCloudMixTaskResResponseMetadata struct {
// REQUIRED
RequestID string `json:"RequestID"`
}
type UpdateCloudMixTaskResResult ¶ added in v1.0.32
type UpdateCloudMixTaskResResult struct {
// REQUIRED; 请求响应码,取值及含义如下。
// * 0:请求成功;
// * 500:内部处理错误;
// * 400:请求异常。
Code int32 `json:"Code"`
// REQUIRED; 返回的数据。
Data UpdateCloudMixTaskResResultData `json:"Data"`
// REQUIRED; 请求响应码对应的信息。
Message string `json:"Message"`
}
type UpdateCloudMixTaskResResultData ¶ added in v1.0.32
type UpdateCloudMixTaskResResultData struct {
// REQUIRED; 任务版本标识符,用来标识更新后的任务版本。
OptID int32 `json:"OptID"`
}
UpdateCloudMixTaskResResultData - 返回的数据。
type UpdateClusterRateLimit ¶ added in v1.0.28
type UpdateClusterRateLimit struct{}
type UpdateClusterRateLimitBody ¶ added in v1.0.28
type UpdateClusterRateLimitBody struct {
// REQUIRED
Limit int32 `json:"Limit"`
// REQUIRED
Type string `json:"Type"`
// REQUIRED
Vhost string `json:"Vhost"`
AggregationPeriod *int32 `json:"AggregationPeriod,omitempty"`
App *string `json:"App,omitempty"`
Domain *string `json:"Domain,omitempty"`
Param *string `json:"Param,omitempty"`
RejectCode *int32 `json:"RejectCode,omitempty"`
RejectDuration *int32 `json:"RejectDuration,omitempty"`
Status *int32 `json:"Status,omitempty"`
}
type UpdateClusterRateLimitQuery ¶ added in v1.0.28
type UpdateClusterRateLimitQuery struct{}
type UpdateClusterRateLimitReq ¶ added in v1.0.28
type UpdateClusterRateLimitReq struct {
*UpdateClusterRateLimitQuery
*UpdateClusterRateLimitBody
}
type UpdateClusterRateLimitRes ¶ added in v1.0.28
type UpdateClusterRateLimitRes struct {
// REQUIRED
ResponseMetadata UpdateClusterRateLimitResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateClusterRateLimitResResponseMetadata ¶ added in v1.0.28
type UpdateClusterRateLimitResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateDomainVhost ¶
type UpdateDomainVhost struct{}
type UpdateDomainVhostBody ¶
type UpdateDomainVhostBody struct {
// REQUIRED; 待修改所属域名空间的的拉流/推流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看域名信息。
Domain string `json:"Domain"`
// REQUIRED; 目的域名空间,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看域名所属的域名空间信息。
Vhost string `json:"Vhost"`
}
type UpdateDomainVhostQuery ¶
type UpdateDomainVhostQuery struct{}
type UpdateDomainVhostReq ¶
type UpdateDomainVhostReq struct {
*UpdateDomainVhostQuery
*UpdateDomainVhostBody
}
type UpdateDomainVhostRes ¶
type UpdateDomainVhostRes struct {
// REQUIRED
ResponseMetadata UpdateDomainVhostResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateDomainVhostResResponseMetadata ¶
type UpdateDomainVhostResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *UpdateDomainVhostResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateEncryptDRM ¶
type UpdateEncryptDRM struct{}
type UpdateEncryptDRMBody ¶
type UpdateEncryptDRMBody struct {
// DRM 证书管理平台 API 访问密钥,获取方法请参见最佳实践-直播 DRM 加密 [https://www.volcengine.com/docs/6469/1219836#在-intertrust-平台创建访问密钥]。
APIKey *string `json:"APIKey,omitempty"`
// 申请 FairPlay 证书过程中 Apple 返回的 ASk(Application Secret Key)字符串。
ApplicationSecretKey *string `json:"ApplicationSecretKey,omitempty"`
// FairPlay 证书文件内容。
CertificateFile *string `json:"CertificateFile,omitempty"`
// FairPlay 证书文件名称。
CertificateFileName *string `json:"CertificateFileName,omitempty"`
// 自定义 FairPlay 证书名称,支持由小写字母(a - z)、数字(0 - 9)和短横线(-)组成,最小长度为 2个字符,最大长度为 128 个字符。FairPlay 证书相关参数的获取方法请参见最佳实践-直播 DRM 加密 [https://www.volcengine.com/docs/6469/1219836#在-apple-官网获取-fairplay-证书]。
CertificateName *string `json:"CertificateName,omitempty"`
// 申请 FairPlay 证书时创建的私钥文件密钥。
PrivateKey *string `json:"PrivateKey,omitempty"`
// 申请 FairPlay 证书时创建的私钥文件内容。
PrivateKeyFile *string `json:"PrivateKeyFile,omitempty"`
// 申请 FairPlay 证书时创建的私钥文件名称。
PrivateKeyFileName *string `json:"PrivateKeyFileName,omitempty"`
}
type UpdateEncryptDRMQuery ¶
type UpdateEncryptDRMQuery struct{}
type UpdateEncryptDRMReq ¶
type UpdateEncryptDRMReq struct {
*UpdateEncryptDRMQuery
*UpdateEncryptDRMBody
}
type UpdateEncryptDRMRes ¶
type UpdateEncryptDRMRes struct {
// REQUIRED
ResponseMetadata UpdateEncryptDRMResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED; 视请求的接口而定
Result interface{} `json:"Result"`
}
type UpdateEncryptDRMResResponseMetadata ¶
type UpdateEncryptDRMResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateEncryptHLS ¶ added in v1.0.32
type UpdateEncryptHLS struct{}
type UpdateEncryptHLSBody ¶ added in v1.0.32
type UpdateEncryptHLSQuery ¶ added in v1.0.32
type UpdateEncryptHLSQuery struct{}
type UpdateEncryptHLSReq ¶ added in v1.0.32
type UpdateEncryptHLSReq struct {
*UpdateEncryptHLSQuery
*UpdateEncryptHLSBody
}
type UpdateEncryptHLSRes ¶ added in v1.0.32
type UpdateEncryptHLSRes struct {
// REQUIRED
ResponseMetadata UpdateEncryptHLSResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateEncryptHLSResResponseMetadata ¶ added in v1.0.32
type UpdateEncryptHLSResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateFormatAccessRule ¶ added in v1.0.28
type UpdateFormatAccessRule struct{}
type UpdateFormatAccessRuleBody ¶ added in v1.0.28
type UpdateFormatAccessRuleBody struct {
// REQUIRED
Domain string `json:"Domain"`
// REQUIRED
FormatAccessRule UpdateFormatAccessRuleBodyFormatAccessRule `json:"FormatAccessRule"`
// REQUIRED
Vhost string `json:"Vhost"`
}
type UpdateFormatAccessRuleBodyFormatAccessRule ¶ added in v1.0.28
type UpdateFormatAccessRuleQuery ¶ added in v1.0.28
type UpdateFormatAccessRuleQuery struct{}
type UpdateFormatAccessRuleReq ¶ added in v1.0.28
type UpdateFormatAccessRuleReq struct {
*UpdateFormatAccessRuleQuery
*UpdateFormatAccessRuleBody
}
type UpdateFormatAccessRuleRes ¶ added in v1.0.28
type UpdateFormatAccessRuleRes struct {
// REQUIRED
ResponseMetadata UpdateFormatAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateFormatAccessRuleResResponseMetadata ¶ added in v1.0.28
type UpdateFormatAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateHLSConfig ¶
type UpdateHLSConfig struct{}
type UpdateHLSConfigBody ¶
type UpdateHLSConfigBody struct {
// REQUIRED; 域名空间
Vhost string `json:"Vhost"`
// 应用名称
App *string `json:"App,omitempty"`
// 永久存储ts,默认为true,也就是清零
CleanUp *bool `json:"CleanUp,omitempty"`
// json配置,通过json的方式添加时填写
Config *string `json:"Config,omitempty"`
// 时间戳置零,默认为false
CopyTs *bool `json:"CopyTs,omitempty"`
// 开启预取,默认false
EnablePrefetch *bool `json:"EnablePrefetch,omitempty"`
// 首个m3u8 ts的个数
FirstPlaylistLength *int32 `json:"FirstPlaylistLength,omitempty"`
// 时间戳gap,默认5s
Gap *int32 `json:"Gap,omitempty"`
Interval *float32 `json:"Interval,omitempty"`
// 切片最大帧数
MaxFrame *int32 `json:"MaxFrame,omitempty"`
// 切片最大大小,单位byte,默认 524288000
MaxSize *int32 `json:"MaxSize,omitempty"`
PDTInterval *float32 `json:"PDTInterval,omitempty"`
// 可选枚举值 "audio_only" "video_only "video_keyframe_only" "video_single_keyframe_only"
PacketFilter *string `json:"PacketFilter,omitempty"`
PartTargetDuration *float32 `json:"PartTargetDuration,omitempty"`
// ts存储位置
Path *string `json:"Path,omitempty"`
// m3u8的ts个数,默认3个
PlaylistLength *int32 `json:"PlaylistLength,omitempty"`
// 预取ts个数
PrefetchNum *int32 `json:"PrefetchNum,omitempty"`
// 服务类型
ServiceType *string `json:"ServiceType,omitempty"`
// ts文件后缀
Suffix *string `json:"Suffix,omitempty"`
// ts缓存时间,单位s,默认60s
TsExpiration *int32 `json:"TsExpiration,omitempty"`
}
type UpdateHLSConfigQuery ¶
type UpdateHLSConfigQuery struct{}
type UpdateHLSConfigReq ¶
type UpdateHLSConfigReq struct {
*UpdateHLSConfigQuery
*UpdateHLSConfigBody
}
type UpdateHLSConfigRes ¶
type UpdateHLSConfigRes struct {
// REQUIRED
ResponseMetadata UpdateHLSConfigResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateHLSConfigResResponseMetadata ¶
type UpdateHLSConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateHTTPHeaderConfig ¶
type UpdateHTTPHeaderConfig struct{}
type UpdateHTTPHeaderConfigBody ¶
type UpdateHTTPHeaderConfigBody struct {
// REQUIRED; 配置完成后是否启用,取值及含义如下所示。
// * true:启用;
// * false:禁用。
Enable bool `json:"Enable"`
// REQUIRED; Header 具体字段配置。
HeaderConfigList []UpdateHTTPHeaderConfigBodyHeaderConfigListItem `json:"HeaderConfigList"`
// REQUIRED; 0: response 1: request
Phase int32 `json:"Phase"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要域名所属的域名空间。
Vhost string `json:"Vhost"`
// 是否保留原 Header 配置,取值及含义如下所示。
// * 0:保留(默认值);
// * 1:不保留。
BlockOriginal *int32 `json:"BlockOriginal,omitempty"`
// 拉流域名。默认为空,表示 Vhost 下的全部拉流域名。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看配置的拉流域名。
Domain *string `json:"Domain,omitempty"`
}
type UpdateHTTPHeaderConfigBodyHeaderConfigListItem ¶
type UpdateHTTPHeaderConfigBodyHeaderConfigListItem struct {
// REQUIRED; Header 配置中字段 Value 值的类型,取值及含义如下所示。
// * 0:常量;
// * 1:变量。
HeaderFieldType int32 `json:"HeaderFieldType"`
// Header 配置中字段的 Key 值,最大长度为 1024 个字符,多个 Header 不可重名。
HeaderKey *string `json:"HeaderKey,omitempty"`
// Header 配置中字段的 Value 值,最大长度为 1024 个字符,支持使用常量和变量作为 Value 值。
// HTTP Header 类型为回源请求头时,支持使用以下变量为 Value 赋值:
// * ${domain}:客户端拉流请求中使用的域名。
// * ${uri}:客户端拉流请求中不包括查询参数的路径。如果请求被重写,则表示重写后的路径。
// * ${args}:客户端拉流请求中的查询参数。如果请求被重写,则表示重写后的参数。
// * ${remote_addr}:发送拉流请求的客户端 IP 地址。
// * ${server_addr}:响应客户端拉流请求的 CDN 节点 IP 地址。
// HTTP Header 类型为请求响应头时,支持使用以下变量为 Value 赋值:
// * ${upstream_host}:客户端拉流请求中使用的域名。
// * ${upstream_uri}:客户端拉流请求中不包括查询参数的路径。如果请求被重写,则表示重写后的路径。
// * ${upstream_args}:客户端拉流请求中的查询参数。如果请求被重写,则表示重写后的参数。
// * ${remote_addr}:发送拉流请求的客户端 IP 地址。
HeaderValue *string `json:"HeaderValue,omitempty"`
}
type UpdateHTTPHeaderConfigQuery ¶
type UpdateHTTPHeaderConfigQuery struct{}
type UpdateHTTPHeaderConfigReq ¶
type UpdateHTTPHeaderConfigReq struct {
*UpdateHTTPHeaderConfigQuery
*UpdateHTTPHeaderConfigBody
}
type UpdateHTTPHeaderConfigRes ¶
type UpdateHTTPHeaderConfigRes struct {
// REQUIRED
ResponseMetadata UpdateHTTPHeaderConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateHTTPHeaderConfigResResponseMetadata ¶
type UpdateHTTPHeaderConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateIPAccessRule ¶
type UpdateIPAccessRule struct{}
type UpdateIPAccessRuleBody ¶
type UpdateIPAccessRuleBody struct {
// REQUIRED; 推流域名或拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要配置
// IP 访问限制的域名。
Domain string `json:"Domain"`
// REQUIRED; IP 访问限制规则。
IPAccessRule UpdateIPAccessRuleBodyIPAccessRule `json:"IPAccessRule"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,获取需要配置
// IP 访问限制的域名所属的域名空间。
Vhost string `json:"Vhost"`
}
type UpdateIPAccessRuleBodyIPAccessRule ¶
type UpdateIPAccessRuleBodyIPAccessRule struct {
// REQUIRED; 是否开启当前限制,取值及含义如下所示。
// * true: 开启;
// * false: 关闭。
Enable bool `json:"Enable"`
// REQUIRED; 名单中的 IP 信息。
IPList []string `json:"IPList"`
// REQUIRED; IP 访问限制的类型,取值及含义如下所示。
// * allow: 白名单;
// * deny: 黑名单。
Type string `json:"Type"`
}
UpdateIPAccessRuleBodyIPAccessRule - IP 访问限制规则。
type UpdateIPAccessRuleQuery ¶
type UpdateIPAccessRuleQuery struct{}
type UpdateIPAccessRuleReq ¶
type UpdateIPAccessRuleReq struct {
*UpdateIPAccessRuleQuery
*UpdateIPAccessRuleBody
}
type UpdateIPAccessRuleRes ¶
type UpdateIPAccessRuleRes struct {
// REQUIRED
ResponseMetadata UpdateIPAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateIPAccessRuleResResponseMetadata ¶
type UpdateIPAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateLatencyConfig ¶
type UpdateLatencyConfig struct{}
type UpdateLatencyConfigBody ¶
type UpdateLatencyConfigQuery ¶
type UpdateLatencyConfigQuery struct{}
type UpdateLatencyConfigReq ¶
type UpdateLatencyConfigReq struct {
*UpdateLatencyConfigQuery
*UpdateLatencyConfigBody
}
type UpdateLatencyConfigRes ¶
type UpdateLatencyConfigRes struct {
// REQUIRED
ResponseMetadata UpdateLatencyConfigResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateLatencyConfigResResponseMetadata ¶
type UpdateLatencyConfigResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdatePullToPushTask ¶
type UpdatePullToPushTask struct{}
type UpdatePullToPushTaskBody ¶
type UpdatePullToPushTaskBody struct {
// REQUIRED; 任务等结束时间,Unix 时间戳,单位为秒。 :::tip 拉流转推任务持续时间最长为 7 天。 :::
EndTime int32 `json:"EndTime"`
// REQUIRED; 任务的开始时间,Unix 时间戳,单位为秒。 :::tip 拉流转推任务持续时间最长为 7 天。 :::
StartTime int32 `json:"StartTime"`
// REQUIRED; 任务 ID,任务的唯一标识,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。
TaskID string `json:"TaskId"`
// REQUIRED; 拉流来源类型,支持的取值及含义如下。
// * 0:直播源;
// * 1:点播视频。
Type int32 `json:"Type"`
// 推流应用名称,推流地址(DstAddr)为空时必传;反之,则该参数不生效
App *string `json:"App,omitempty"`
// 接收拉流转推任务状态回调的地址,最大长度为 512 个字符。
CallbackURL *string `json:"CallbackURL,omitempty"`
// 续播策略,续播策略指转推点播视频进行直播时出现断流并恢复后,如何继续播放的策略,拉流来源类型为点播视频(Type 为 1)时参数生效,支持的取值及含义如下。
// * 0:从断流处续播(默认值);
// * 1:从断流处+自然流逝时长处续播。
ContinueStrategy *int32 `json:"ContinueStrategy,omitempty"`
// 点播视频文件循环播放模式,当拉流来源类型为点播视频时为必选参数,参数取值及含义如下所示。
// * -1:无限次循环,至任务结束;
// * 0:有限次循环,循环次数以 PlayTimes 取值为准;
// * >0:有限次循环,循环次数以 CycleMode 取值为准。
CycleMode *int32 `json:"CycleMode,omitempty"`
// 推流域名,推流地址(DstAddr)为空时必传;反之,则该参数不生效
Domain *string `json:"Domain,omitempty"`
// 推流地址,即直播源或点播视频转推的目标地址。
DstAddr *string `json:"DstAddr,omitempty"`
// 任务所属的群组名称,您可以通过获取拉流转推任务列表 [https://www.volcengine.com/docs/6469/1126896]接口获取。 :::tip
// * 群组名称不支持更新,仅做校验使用。
// * 使用主账号调用时,为非必填。
// * 使用子账号调用时,为必填。 :::
GroupName *string `json:"GroupName,omitempty"`
// 点播文件启播时间偏移值,单位为秒,仅当点播视频播放地址列表(SrcAddrS)只有一个地址,且未配置 Offsets 时生效,缺省情况下表示不进行偏移。
Offset *float32 `json:"Offset,omitempty"`
// 点播文件启播时间偏移值,单位为秒,数量与拉流地址列表中地址数量相等,缺省情况下表示不进行偏移。 拉流来源类型为点播视频(Type 为 1)时,参数生效。
OffsetS []*float32 `json:"OffsetS,omitempty"`
// 点播视频文件循环播放次数,当 CycleMode 取值为 0 时,PlayTimes 取值将作为循环播放次数。 :::tip PlayTimes 为冗余参数,您可以将 PlayTimes 置 0 后直接使用 CycleMode 指定点播视频文件循环播放次数。
// :::
PlayTimes *int32 `json:"PlayTimes,omitempty"`
// 是否开启点播预热,开启点播预热后,系统会自动将点播视频文件缓存到 CDN 节点上,当用户请求直播时,可以直播从 CDN 节点获取视频,从而提高直播流畅度。 拉流来源类型为点播视频(Type 为 1)时,参数生效。
// * 0:不开启;
// * 1:开启(默认值)。
PreDownload *int32 `json:"PreDownload,omitempty"`
// 直播源的拉流地址,拉流来源类型为直播源(Type 为 0)时,为必选参数,最大长度为 1000 个字符。
SrcAddr *string `json:"SrcAddr,omitempty"`
// 点播视频播放地址列表,拉流来源类型为点播视频(Type 为 1)时,为必选参数,最多支持传入 30 个点播视频播放地址,每个地址最大长度为 1000 个字符。
SrcAddrS []*string `json:"SrcAddrS,omitempty"`
// 推流的流名称,推流地址(DstAddr)为空时必传;反之,则该参数不生效
Stream *string `json:"Stream,omitempty"`
// 拉流转推任务的名称,默认为空表示不配置任务名称。支持由中文、大小写字母(A - Z、a - z)和数字(0 - 9)组成,长度为 1 到 20 各字符。
Title *string `json:"Title,omitempty"`
// 点播文件地址和开始播放、结束播放的时间设置。 :::tip
// * 当 Type 为点播类型时配置生效。
// * 与 SrcAddrS 和 OffsetS 字段不可同时填写。 :::
VodSrcAddrs []*UpdatePullToPushTaskBodyVodSrcAddrsItem `json:"VodSrcAddrs,omitempty"`
// 为拉流转推视频添加的水印配置信息。
Watermark *UpdatePullToPushTaskBodyWatermark `json:"Watermark,omitempty"`
}
type UpdatePullToPushTaskBodyVodSrcAddrsItem ¶ added in v1.0.32
type UpdatePullToPushTaskBodyWatermark ¶
type UpdatePullToPushTaskBodyWatermark struct {
// REQUIRED; 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/<mediatype>;base64,<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
Picture string `json:"Picture"`
// REQUIRED; 水印宽度占直播原始画面宽度百分比,支持精度为小数点后两位。
Ratio float32 `json:"Ratio"`
// REQUIRED; 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosX float32 `json:"RelativePosX"`
// REQUIRED; 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1)。
RelativePosY float32 `json:"RelativePosY"`
}
UpdatePullToPushTaskBodyWatermark - 为拉流转推视频添加的水印配置信息。
type UpdatePullToPushTaskQuery ¶
type UpdatePullToPushTaskQuery struct{}
type UpdatePullToPushTaskReq ¶
type UpdatePullToPushTaskReq struct {
*UpdatePullToPushTaskQuery
*UpdatePullToPushTaskBody
}
type UpdatePullToPushTaskRes ¶
type UpdatePullToPushTaskRes struct {
// REQUIRED
ResponseMetadata UpdatePullToPushTaskResResponseMetadata `json:"ResponseMetadata"`
}
type UpdatePullToPushTaskResResponseMetadata ¶
type UpdatePullToPushTaskResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdatePullToPushTaskResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateRecordPresetV2 ¶
type UpdateRecordPresetV2 struct{}
type UpdateRecordPresetV2Body ¶
type UpdateRecordPresetV2Body struct {
// REQUIRED; 录制配置的名称。您可以调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858] 接口查看待更新录制配置的 Name 取值。
Preset string `json:"Preset"`
// REQUIRED; 域名空间。您可以调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858] 接口查看待更新录制配置的 Vhost 取值。
Vhost string `json:"Vhost"`
// 应用名称,取值与直播流地址的 AppName 字段取值相同,用来指定待更新的录制配置,默认为空。您可以调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858]
// 接口查看待更新录制配置的 App 取值。
App *string `json:"App,omitempty"`
// 录制配置的详细参数配置。
// :::tip 以下录制参数,未传入值时表示与更新前的配置相同。 :::
RecordPresetConfig *UpdateRecordPresetV2BodyRecordPresetConfig `json:"RecordPresetConfig,omitempty"`
// 流名称,取值与直播流地址的 StreamName 字段取值相应,用来指定待更新的录制配置,默认为空。您可以调用 ListVhostRecordPresetV2 [https://www.volcengine.com/docs/6469/1126858]
// 接口查看待更新录制配置的 Stream 取值。
Stream *string `json:"Stream,omitempty"`
}
type UpdateRecordPresetV2BodyRecordPresetConfig ¶
type UpdateRecordPresetV2BodyRecordPresetConfig struct {
// 录制为 FLV 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
FlvParam *UpdateRecordPresetV2BodyRecordPresetConfigFlvParam `json:"FlvParam,omitempty"`
// 录制为 HLS 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
HlsParam *UpdateRecordPresetV2BodyRecordPresetConfigHlsParam `json:"HlsParam,omitempty"`
// 录制为 MP4 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
Mp4Param *UpdateRecordPresetV2BodyRecordPresetConfigMp4Param `json:"Mp4Param,omitempty"`
// 是否录制源流,默认值为 0,支持的取值及含义如下所示。
// * 0:不录制;
// * 1:录制。
// :::tip 转码流和源流需至少选一个进行录制,即是否录制转码流(TranscodeRecord)和是否录制源流(OriginRecord)的取值至少一个不为 0。 :::
OriginRecord *int32 `json:"OriginRecord,omitempty"`
// 录制为 HLS 格式时,单个 TS 切片时长,单位为秒,默认值为 10,取值范围为 [5,30]。
SliceDuration *int32 `json:"SliceDuration,omitempty"`
// 是否录制转码流,默认值为 0。支持的取值如下所示。
// * 0:不录制;
// * 1:录制全部转码流;
// * 2:录制指定转码流,即通过转码后缀列表 TranscodeSuffixList匹配转码流进行录制,如果转码流后缀列表为空仍表示录制全部转码流。
// :::tip 转码流和源流需至少选一个进行录制,即是否录制转码流(TranscodeRecord)和是否录制源流(OriginRecord)的取值至少一个不为 0。 :::
TranscodeRecord *int32 `json:"TranscodeRecord,omitempty"`
// 转码流后缀列表,是否录制转码设置为根据转码流列表匹配(TranscodeRecord 取值为 2)时生效,TranscodeSuffixList 默认配置为空,效果等同于录制全部转码流。
TranscodeSuffixList []*string `json:"TranscodeSuffixList,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfig - 录制配置的详细参数配置。 :::tip 以下录制参数,未传入值时表示与更新前的配置相同。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParam struct {
// 实时录制场景下,断流等待时长,单位为秒,默认值为 180,取值范围为 [0,3600]。如果实际断流时间小于断流等待时长,录制任务不会停止;如果实际断流时间大于断流等待时长,录制任务会停止,断流恢复后重新开始一个新的录制任务。
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制场景下,单文件录制时长,单位为秒,默认值为 7200,取值范围为 -1 和 [300,86400]。
// * 取值为 -1 时,表示不限制录制时长,录制结束后生成一个完整的录制文件。
// * 取值为 [300,86400] 之间的值时,表示根据设置的录制文件时长,到达时长立即生成录制文件,完成录制后一起上传。
// :::tip
// * 断流录制场景仅在录制格式为 HLS 时生效,且断流录制和实时录制为二选一配置。
// * 如录制过程中出现断流,对应生成的录制文件时长也会相应缩短。 :::
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制场景下,单文件录制时长,单位为秒,默认值为 1800,取值范围为 [300,21600]。录制时间到达设置的单文件录制时长时,会立即生成录制文件实时上传存储。 :::tip 如录制过程中出现断流,对应生成的录制文件时长也会相应缩短。
// :::
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流录制场景下,断流拼接时长,单位为秒,默认值为 0,支持的取值及含义如下所示。
// * -1:一直拼接,表示每次断流都不会影响录制任务,录制完成后生成一个完整的录制文件;
// * 0:不拼接,表示每次断流结束录制任务生成一个录制文件,断流恢复重新开始一个新的录制任务;
// * 大于 0:拼接容错时间,表示如果断流时间小于拼接容错时间时,则录制任务不会停止,不会生成新的录制文件;如果断流时间大于拼接容错时间,则录制任务停止,断流恢复后重新开始一个新的录制任务。
// :::tip 断流录制场景仅在录制格式为 HLS 时生效,且断流录制和实时录制为二选一配置。 :::
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
TOSParam *UpdateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
VODParam *UpdateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam `json:"VODParam,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigFlvParam - 录制为 FLV 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam struct {
// TOS 存储对应的 Bucket。例如,存储位置为 live-test-tos-example/live/liveapp 时,Bucket 取值为 live-test-tos-example。 :::tip 如果使用 TOS 存储,即 TOSParam
// 中 Enable 取值为 true 时,Bucket 为必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储规则,最大长度为 200 个字符,支持以record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} 样式设置存储规则,支持输入字母(A - Z、a - z)、数字(0 -
// 9)、短横线(-)、叹号(!)、下划线(_)、句点(.)、星号(*)及占位符。
// 存储规则设置注意事项如下。
// * 目录层级至少包含2级及以上,如live/{App}/{Stream}。
// * record 为自定义字段;
// * {PubDomain} 取值为当前配置的 vhost 值;
// * {App} 取值为当前配置的 AppName 值;
// * {Stream} 取值为当前配置的 StreamName 值;
// * {StartTime} 取值为录制的开始时间戳;
// * {EndTime} 取值为录制的结束时间戳。
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储对应 Bucket 下的存储目录,默认为空。例如,存储位置为 live-test-tos-example/live/liveapp 时,StorageDir 取值为 live/liveapp。
StorageDir *string `json:"StorageDir,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigFlvParamTOSParam - TOS 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息,默认为空。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储规则,最大长度为 200 个字符,支持以record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime} 样式设置存储规则,支持输入字母(A - Z、a - z)、数字(0 -
// 9)、短横线(-)、叹号(!)、下划线(_)、句点(.)、星号(*)及占位符。
// 存储规则设置注意事项如下。
// * 目录层级至少包含2级及以上,如live/{App}/{Stream}。
// * record 为自定义字段;
// * {PubDomain} 取值为当前配置的 vhost 值;
// * {App} 取值为当前配置的 AppName 值;
// * {Stream} 取值为当前配置的 StreamName 值;
// * {StartTime} 取值为录制的开始时间戳;
// * {EndTime} 取值为录制的结束时间戳。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型,存储类型介绍请参考媒资存储管理 [https://www.volcengine.com/docs/4/73629#媒资存储]。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询。 :::tip 如果使用 VOD 存储,即 VODParam 中 Enable 取值为 true 时,VodNamespace
// 为必填。 :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 视频点播工作流模板 ID,对于存储在点播的录制文件,会使用该工作流模版对录制的视频进行处理,可登录视频点播控制台 [https://console.volcengine.com/vod/]获取工作流模板 ID,默认为空。
WorkflowID *string `json:"WorkflowID,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigFlvParamVODParam - VOD 存储相关配置。 :::tip 录制文件只能选择一个位置进行存储,即 TOSParam 和 VODParam 配置且配置其中一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParam struct {
// 断流等待时长,取值范围[0, 3600]。
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制单文件录制时长,单位为 s,默认值为 7200,取值范围为 -1,[300,86400],-1表示一直录制,目前只对 HLS 生效。
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制文件时长,单位为 s,取值范围为 [300,21600]。
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流拼接间隔时长,对实时录制无效,单位为 s,默认值为 0。支持的取值如下所示。
// * -1:一直拼接;
// * 0:不拼接;
// * 大于 0:断流拼接时间间隔,对 HLS 录制生效。
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
TOSParam *UpdateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
VODParam *UpdateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam `json:"VODParam,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigHlsParam - 录制为 HLS 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam struct {
// TOS 存储空间,一般使用 CDN 对应的 Bucket。 :::tip 如果 TOSParam 中的 Enable 取值为 true,则 Bucket 必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置。存储路径为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储目录,默认为空。
StorageDir *string `json:"StorageDir,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigHlsParamTOSParam - TOS 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置,最大长度为 200 个字符。默认的存储位置为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime},参数格式要求如下所示。
// * 支持删除固定路径,如 {App}/{Stream};
// * 不支持以正斜线(/)或者反斜线(\)开头;
// * 不支持 “//” 和 “/./” 等字符串;
// * 不支持 \b、\t、\n、\v、\f、\r 等字符;
// * 不支持 “..” 作为文件名;
// * 目录层级至少包含 2 级及以上,如live/{App}/{Stream}。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询。 :::tip 如果 VODParam 中的 Enable 取值为 true,则 VodNamespace
// 必填。 :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 工作流模版 ID,对于存储在点播的录制文件,会使用该工作流模版对视频进行处理。可登录视频点播控制台 [https://console.volcengine.com/vod/]获取 ID。
WorkflowID *string `json:"WorkflowID,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigHlsParamVODParam - VOD 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigMp4Param ¶
type UpdateRecordPresetV2BodyRecordPresetConfigMp4Param struct {
// 断流等待时长,取值范围[0, 3600]。
ContinueDuration *int32 `json:"ContinueDuration,omitempty"`
// 断流录制单文件录制时长,单位为 s,默认值为 7200,取值范围为 -1,[300,86400],-1表示一直录制,目前只对 HLS 生效。
Duration *int32 `json:"Duration,omitempty"`
// 当前格式的录制是否开启,默认 false,取值及含义如下所示。
// * false:不开启;
// * true:开启。
Enable *bool `json:"Enable,omitempty"`
// 实时录制文件时长,单位为 s,取值范围为 [300,21600]。
RealtimeRecordDuration *int32 `json:"RealtimeRecordDuration,omitempty"`
// 断流拼接间隔时长,对实时录制无效,单位为 s,默认值为 0。支持的取值如下所示。
// * -1:一直拼接;
// * 0:不拼接;
// * 大于 0:断流拼接时间间隔,对 HLS 录制生效。
Splice *int32 `json:"Splice,omitempty"`
// TOS 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
TOSParam *UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam `json:"TOSParam,omitempty"`
// VOD 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
VODParam *UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam `json:"VODParam,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigMp4Param - 录制为 MP4 格式时的录制参数。 :::tip 您需至少配置一个录制格式,即 FlvParam、HlsParam、Mp4Param 至少开启一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam struct {
// TOS 存储空间,一般使用 CDN 对应的 Bucket。 :::tip 如果 TOSParam 中的 Enable 取值为 true,则 Bucket 必填。 :::
Bucket *string `json:"Bucket,omitempty"`
// 是否使用 TOS 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置。存储路径为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}
ExactObject *string `json:"ExactObject,omitempty"`
// TOS 存储目录,默认为空。
StorageDir *string `json:"StorageDir,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamTOSParam - TOS 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam ¶
type UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam struct {
// 直播录制文件存储到点播时的视频分类 ID,您可以通过视频点播的ListVideoClassifications [https://www.volcengine.com/docs/4/101661]接口查询视频分类 ID 等信息。
ClassificationID *int32 `json:"ClassificationID,omitempty"`
// 是否使用 VOD 存储,默认为 false,取值及含义如下所示。
// * false:不使用;
// * true:使用。
Enable *bool `json:"Enable,omitempty"`
// 录制文件的存储位置,最大长度为 200 个字符。默认的存储位置为record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime},参数格式要求如下所示。
// * 支持删除固定路径,如 {App}/{Stream};
// * 不支持以正斜线(/)或者反斜线(\)开头;
// * 不支持 “//” 和 “/./” 等字符串;
// * 不支持 \b、\t、\n、\v、\f、\r 等字符;
// * 不支持 “..” 作为文件名;
// * 目录层级至少包含 2 级及以上,如live/{App}/{Stream}。
ExactObject *string `json:"ExactObject,omitempty"`
// 直播录制文件存储到点播时的存储类型。默认值为 1,支持的取值及含义如下所示。
// * 1:标准存储;
// * 2:归档存储。
StorageClass *int32 `json:"StorageClass,omitempty"`
// 视频点播(VOD)空间名称。可登录视频点播控制台 [https://console.volcengine.com/vod/]查询。 :::tip 如果 VODParam 中的 Enable 取值为 true,则 VodNamespace
// 必填。 :::
VodNamespace *string `json:"VodNamespace,omitempty"`
// 工作流模版 ID,对于存储在点播的录制文件,会使用该工作流模版对视频进行处理。可登录视频点播控制台 [https://console.volcengine.com/vod/]获取 ID。
WorkflowID *string `json:"WorkflowID,omitempty"`
}
UpdateRecordPresetV2BodyRecordPresetConfigMp4ParamVODParam - VOD 存储相关配置。 :::tipTOSParam和VODParam配置且配置其中一个。 :::
type UpdateRecordPresetV2Query ¶
type UpdateRecordPresetV2Query struct{}
type UpdateRecordPresetV2Req ¶
type UpdateRecordPresetV2Req struct {
*UpdateRecordPresetV2Query
*UpdateRecordPresetV2Body
}
type UpdateRecordPresetV2Res ¶
type UpdateRecordPresetV2Res struct {
// REQUIRED
ResponseMetadata UpdateRecordPresetV2ResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateRecordPresetV2ResResponseMetadata ¶
type UpdateRecordPresetV2ResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
Error *UpdateRecordPresetV2ResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateReferer ¶
type UpdateReferer struct{}
type UpdateRefererBody ¶
type UpdateRefererBody struct {
// REQUIRED; Referer 防盗链规则列表。 :::tip
// * 同一个 Vhost 下,默认支持配置不超过 100 个 Referer 规则,如需提升限额请创建工单 [https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076]获取技术支持;
// * 单次请求最多支持配置 100 个 Referer 规则。 :::
RefererInfoList []UpdateRefererBodyRefererInfoListItem `json:"RefererInfoList"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看需要查询的直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示所有应用名称。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 :::tip
// 参数 Domain 和 App 传且仅传一个。 :::
App *string `json:"App,omitempty"`
// 拉流域名,您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的拉流域名。
// :::tip 参数 Domain 和 App 传且仅传一个。 :::
Domain *string `json:"Domain,omitempty"`
}
type UpdateRefererBodyRefererInfoListItem ¶
type UpdateRefererBodyRefererInfoListItem struct {
// REQUIRED; 用于标识 referer 防盗链的关键词默认取值为 referer。
Key string `json:"Key"`
// REQUIRED; Referer 字段规则类型,取值即含义如下所示。
// * deny:拒绝,即黑名单;
// * allow:通过,即白名单。
Type string `json:"Type"`
// Referer 字段规则的匹配优先级,默认为 0,取值范围为 [0,100],数值越大,优先级越高。如果优先级相同,则越早加入列表的域名优先级越高。
Priority *int32 `json:"Priority,omitempty"`
// Referer 字段规则,即设置的黑名单或白名单的域名,最大长度限制 300 个字符。
Value *string `json:"Value,omitempty"`
}
type UpdateRefererQuery ¶
type UpdateRefererQuery struct{}
type UpdateRefererReq ¶
type UpdateRefererReq struct {
*UpdateRefererQuery
*UpdateRefererBody
}
type UpdateRefererRes ¶
type UpdateRefererRes struct {
// REQUIRED
ResponseMetadata UpdateRefererResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateRefererResResponseMetadata ¶
type UpdateRefererResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateRefererResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateRegionAccessRule ¶ added in v1.0.28
type UpdateRegionAccessRule struct{}
type UpdateRegionAccessRuleBody ¶ added in v1.0.28
type UpdateRegionAccessRuleBody struct {
// REQUIRED
Domain string `json:"Domain"`
// REQUIRED
RegionAccessRule UpdateRegionAccessRuleBodyRegionAccessRule `json:"RegionAccessRule"`
// REQUIRED
Vhost string `json:"Vhost"`
App *string `json:"App,omitempty"`
}
type UpdateRegionAccessRuleBodyRegionAccessRule ¶ added in v1.0.28
type UpdateRegionAccessRuleBodyRegionAccessRule struct {
// REQUIRED
Enable string `json:"Enable"`
// REQUIRED
Type string `json:"Type"`
// 限制国家列表,传入使用国家代码,遵循iso-3166
CountryList []*string `json:"CountryList,omitempty"`
// 限制省份列表,目前仅支持中国香港地区、中国澳门地区和中国台湾地区。分别对应代码为HK, MO, TW
ProvinceList []*string `json:"ProvinceList,omitempty"`
}
type UpdateRegionAccessRuleQuery ¶ added in v1.0.28
type UpdateRegionAccessRuleQuery struct{}
type UpdateRegionAccessRuleReq ¶ added in v1.0.28
type UpdateRegionAccessRuleReq struct {
*UpdateRegionAccessRuleQuery
*UpdateRegionAccessRuleBody
}
type UpdateRegionAccessRuleRes ¶ added in v1.0.28
type UpdateRegionAccessRuleRes struct {
// REQUIRED
ResponseMetadata UpdateRegionAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateRegionAccessRuleResResponseMetadata ¶ added in v1.0.28
type UpdateRegionAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateRelaySourceRewrite ¶
type UpdateRelaySourceRewrite struct{}
type UpdateRelaySourceRewriteBody ¶
type UpdateRelaySourceRewriteBody struct {
// REQUIRED; 域名空间名称
Vhost string `json:"Vhost"`
// 需要设置黑白名单的拉流域名。域名请在工信部完成备案。
Domain *string `json:"Domain,omitempty"`
// 改写规则
RewriteRule *UpdateRelaySourceRewriteBodyRewriteRule `json:"RewriteRule,omitempty"`
}
type UpdateRelaySourceRewriteBodyRewriteRule ¶
type UpdateRelaySourceRewriteBodyRewriteRule struct {
// REQUIRED; 功能开关。- true: 开 - false: 关
Enable bool `json:"Enable"`
// REQUIRED; 改写规则列表
RewriteRuleList []UpdateRelaySourceRewriteBodyRewriteRuleListItem `json:"RewriteRuleList"`
}
UpdateRelaySourceRewriteBodyRewriteRule - 改写规则
type UpdateRelaySourceRewriteQuery ¶
type UpdateRelaySourceRewriteQuery struct{}
type UpdateRelaySourceRewriteReq ¶
type UpdateRelaySourceRewriteReq struct {
*UpdateRelaySourceRewriteQuery
*UpdateRelaySourceRewriteBody
}
type UpdateRelaySourceRewriteRes ¶
type UpdateRelaySourceRewriteRes struct {
// REQUIRED
ResponseMetadata UpdateRelaySourceRewriteResResponseMetadata `json:"ResponseMetadata"`
// REQUIRED; Anything
Result interface{} `json:"Result"`
}
type UpdateRelaySourceV3 ¶
type UpdateRelaySourceV3 struct{}
type UpdateRelaySourceV3Body ¶
type UpdateRelaySourceV3Body struct {
// REQUIRED; 回源组配置详情。
GroupDetails []UpdateRelaySourceV3BodyGroupDetailsItem `json:"GroupDetails"`
// REQUIRED; 域名空间,即直播流地址的域名所属的域名空间。您可以调用ListDomainDetail [https://www.volcengine.com/docs/6469/1126815]接口或在视频直播控制台的域名管理 [https://console.volcengine.com/live/main/domain/list]页面,查看直播流使用的域名所属的域名空间。
Vhost string `json:"Vhost"`
// 应用名称,即直播流地址的AppName字段取值,默认为空,表示为当前域名空间的全局播放触发回源配置。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
App *string `json:"App,omitempty"`
// 生效类型(order/rand/hot),不填默认order
LBType *string `json:"LBType,omitempty"`
// 组的重试间隔/s,不填默认为1 s。
RetryInterval *string `json:"RetryInterval,omitempty"`
// 组的重试次数,不填默认等于group数-1
RetryTimes *string `json:"RetryTimes,omitempty"`
}
type UpdateRelaySourceV3BodyGroupDetailsItem ¶
type UpdateRelaySourceV3BodyGroupDetailsItem struct {
// REQUIRED; 回源组名称。
Group string `json:"Group"`
// REQUIRED; 回源服务器配置列表。
Servers []UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsItem `json:"Servers"`
AuthParams *UpdateRelaySourceV3BodyGroupDetailsItemAuthParams `json:"AuthParams,omitempty"`
// 主还是备
Backup *bool `json:"Backup,omitempty"`
// CDN类型
CDN *string `json:"CDN,omitempty"`
// 应用层超时时间/s
ConnTimeout *string `json:"ConnTimeout,omitempty"`
// 传输层超时时间/s (不配置的话使用应用层时间)
DialTimeout *string `json:"DialTimeout,omitempty"`
// 是否禁用
Disable *bool `json:"Disable,omitempty"`
// server生效类型(order/rand/hot)
LBType *string `json:"LBType,omitempty"`
// 主secret key
PrimarySK *string `json:"PrimarySK,omitempty"`
// 不上火山
PullAuth *bool `json:"PullAuth,omitempty"`
// server重试间隔/s
RetryInterval *string `json:"RetryInterval,omitempty"`
// server重试次数
RetryTimes *string `json:"RetryTimes,omitempty"`
// 回源规则
Rule *string `json:"Rule,omitempty"`
// 副secret key
SecondSK *string `json:"SecondSK,omitempty"`
// Group 超时时间/s
Timeout *string `json:"Timeout,omitempty"`
// 鉴权有效时长
ValidDuration *string `json:"ValidDuration,omitempty"`
// 权重
Weight *string `json:"Weight,omitempty"`
}
type UpdateRelaySourceV3BodyGroupDetailsItemServersItemOutboundConfig ¶
type UpdateRelaySourceV3BodyGroupDetailsItemServersItemOutboundConfig struct {
// 代理配置列表,不传默认不使用代理
ProxyConfigList []*UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListItem `json:"ProxyConfigList,omitempty"`
// 代理模式,0:固定模式,1: 解析模式,2:默认模式
ProxyMode *string `json:"ProxyMode,omitempty"`
}
type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsItem ¶
type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsItem struct {
// REQUIRED; 直播源服务器的地址,支持填写回源服务的域名或 IP 地址。 :::tip
// * 当源站使用了非默认端口时,支持在回源地址中以域名:端口或IP:端口的形式配置端口。
// * 最多支持添加 10 个回源地址,回源失败时,将按照您添加的地址顺序轮循尝试。 :::
RelaySourceDomain string `json:"RelaySourceDomain"`
// REQUIRED; 回源协议,支持两种回源协议。
// * rtmp:RTMP 回源协议;
// * flv:FLV 回源协议。
RelaySourceProtocol string `json:"RelaySourceProtocol"`
// 回源Host
Host *string `json:"Host,omitempty"`
OutboundConfig *UpdateRelaySourceV3BodyGroupDetailsItemServersItemOutboundConfig `json:"OutboundConfig,omitempty"`
// 自定义回源参数,缺省情况下为空。格式为"Key":"Value",例如,"domain":"live.push.net"。
RelaySourceParams map[string]*string `json:"RelaySourceParams,omitempty"`
// 权重
Weight *string `json:"Weight,omitempty"`
}
type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListItem ¶
type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListItem struct {
// 集群
Cluster *string `json:"Cluster,omitempty"`
// 机房
IDC *string `json:"IDC,omitempty"`
// 运营商
ISP *string `json:"ISP,omitempty"`
// 代理列表
ProxyList []*UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListPropertiesItemsItem `json:"ProxyList,omitempty"`
}
type UpdateRelaySourceV3BodyGroupDetailsPropertiesItemsOutboundConfigProxyConfigListPropertiesItemsItem ¶
type UpdateRelaySourceV3Query ¶
type UpdateRelaySourceV3Query struct{}
type UpdateRelaySourceV3Req ¶
type UpdateRelaySourceV3Req struct {
*UpdateRelaySourceV3Query
*UpdateRelaySourceV3Body
}
type UpdateRelaySourceV3Res ¶
type UpdateRelaySourceV3Res struct {
// REQUIRED
ResponseMetadata UpdateRelaySourceV3ResResponseMetadata `json:"ResponseMetadata"`
}
type UpdateRelaySourceV3ResResponseMetadata ¶
type UpdateRelaySourceV3ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateRelaySourceV3ResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateSnapshotPreset ¶
type UpdateSnapshotPreset struct{}
type UpdateSnapshotPresetBody ¶
type UpdateSnapshotPresetBody struct {
// REQUIRED; 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
App string `json:"App"`
// REQUIRED; 截图模板名称。
Preset string `json:"Preset"`
// REQUIRED; 域名空间名称。
Vhost string `json:"Vhost"`
// ToS 的存储 Bucket。 :::tipBucket 与 ServiceID 传且仅传一个。 :::
Bucket *string `json:"Bucket,omitempty"`
// 回调详情。
CallbackDetailList []*UpdateSnapshotPresetBodyCallbackDetailListItem `json:"CallbackDetailList,omitempty"`
// 截图间隔时间,单位为 s,默认值为 10,取值范围为正整数
Interval *int32 `json:"Interval,omitempty"`
// 存储方式为覆盖截图时的存储规则,支持以 {Domain}/{App}/{Stream} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。
OverwriteObject *string `json:"OverwriteObject,omitempty"`
// veImageX 的服务 ID。 :::tipBucket 与 ServiceID 传且仅传一个。 :::
ServiceID *string `json:"ServiceID,omitempty"`
// 截图格式。支持如下取值。- jpeg - jpg
SnapshotFormat *string `json:"SnapshotFormat,omitempty"`
// 存储方式为实时存储时的存储规则,支持以 {Domain}/{App}/{Stream}/{UnixTimestamp} 样式设置存储规则,支持输入字母、数字、"-"、"!"、"_"、"."、"*"及占位符。
SnapshotObject *string `json:"SnapshotObject,omitempty"`
// 截图模版状态。
// * 1:开启
// * 0:关闭
Status *int32 `json:"Status,omitempty"`
// ToS 的存储目录,不传为空。
StorageDir *string `json:"StorageDir,omitempty"`
}
type UpdateSnapshotPresetQuery ¶
type UpdateSnapshotPresetQuery struct{}
type UpdateSnapshotPresetReq ¶
type UpdateSnapshotPresetReq struct {
*UpdateSnapshotPresetQuery
*UpdateSnapshotPresetBody
}
type UpdateSnapshotPresetRes ¶
type UpdateSnapshotPresetRes struct {
// REQUIRED
ResponseMetadata UpdateSnapshotPresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateSnapshotPresetResResponseMetadata ¶
type UpdateSnapshotPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateSnapshotPresetResResponseMetadataError `json:"Error,omitempty"`
}
type UpdateSubtitleTranscodePreset ¶ added in v1.0.32
type UpdateSubtitleTranscodePreset struct{}
type UpdateSubtitleTranscodePresetBody ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBody struct {
// REQUIRED; 应用名称,您可以调用ListVhostSubtitleTranscodePreset [https://www.volcengine.com/docs/6469/1288712]接口,获取待更新字幕配置的 App 取值。
App string `json:"App"`
// REQUIRED; 截图配置的名称,您可以调用ListVhostSubtitleTranscodePreset [https://www.volcengine.com/docs/6469/1288712]接口,获取待更新字幕配置的 PresetName
// 取值。
PresetName string `json:"PresetName"`
// REQUIRED; 原文字幕展示参数配置。
SourceLanguage UpdateSubtitleTranscodePresetBodySourceLanguage `json:"SourceLanguage"`
// REQUIRED; 关联转码配置后缀,一个字幕配置支持关联多个转码配置后缀。
Suffixes []string `json:"Suffixes"`
// REQUIRED; 域名空间,您可以调用 ListVhostSubtitleTranscodePreset [https://www.volcengine.com/docs/6469/1288712] 接口,获取待更新字幕配置的 Vhost
// 取值。
Vhost string `json:"Vhost"`
// 字幕配置的描述信息。
Description *string `json:"Description,omitempty"`
// 预设配置,使用预设配置是系统将自动对字体大小、字幕行数、每行最大字符数和边距参数(MarginVertical 和 MarginHorizontal)进行智能化适配。默认为空,表示不使用预设配置,支持的预设配置如下所示。
// * small :小字幕。
// * medium:中字幕。
// * large:大字幕。 :::tip 使用预设配置时,字幕行数、每行最大字符数、左右边距和底部边距参数不生效,系统将使用预设配置自动进行计算。 :::
DisplayPreset *string `json:"DisplayPreset,omitempty"`
// 原文翻译成译文时使用的热词词库,总长度不超过 10000 个字符,默认为空。
GlossaryWordList []*string `json:"GlossaryWordList,omitempty"`
// 原文字幕识别时使用的热词词库,总长度不超过为 10000 个字符,默认为空。
HotWordList []*string `json:"HotWordList,omitempty"`
// 设置在 16:9 分辨率场景下,每行字幕展示的最大字符数。 :::tip
// * 使用预设配置时,字幕每行最大字符数设置不生效。
// * 不使用预设配置时,字幕每行最大字符数必填。
// * 每个文字、字母、符号或数字均为一个字符。
// * 当屏幕分辨率改变时,屏幕上显示的每行文字数量会相应调整,以适应新的分辨率,确保文字的显示效果和阅读体验。 :::
MaxCharNumber *int32 `json:"MaxCharNumber,omitempty"`
// 字幕展示的行数,同时适用于原文字幕和译文字幕,支持的取值及含义如下所示。
// * 0:(默认值)根据字幕字数自动进行分行展示;
// * 1:每种字幕展示一行;
// * 2:每种字幕展示两行。 :::tip
// * 使用预设配置时,字幕行数为自动分行展示。
// * 超出行内字数限制时表示字幕将超过显示范围,此时字幕内容将被截断。 :::
MaxRowNumber *int32 `json:"MaxRowNumber,omitempty"`
// 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。
// :::tip
// * 使用预设配置时,字幕位置设置不生效。
// * 不使用预设配置时,字幕位置设置必填。 :::
Position *UpdateSubtitleTranscodePresetBodyPosition `json:"Position,omitempty"`
// 译文字幕展示参数配置列表,当前最多支持配置一种译文。
TargetLanguage []*UpdateSubtitleTranscodePresetBodyTargetLanguageItem `json:"TargetLanguage,omitempty"`
}
type UpdateSubtitleTranscodePresetBodyPosition ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBodyPosition struct {
// 字幕距离画面两侧的边距与画面宽度的占比,使用归一化百分表示,取值范围为 [0,0.2]。
MarginHorizontal *float32 `json:"MarginHorizontal,omitempty"`
// 字幕距离画面底部的边距与画面高度的占比,使用归一化百分表示,取值范围为 [0,0.5]。
MarginVertical *float32 `json:"MarginVertical,omitempty"`
Relative *string `json:"Relative,omitempty"`
}
UpdateSubtitleTranscodePresetBodyPosition - 字幕位置设置,通过设置字幕距离画面左右边距和底部边距来指定字幕位置。 :::tip * 使用预设配置时,字幕位置设置不生效。 * 不使用预设配置时,字幕位置设置必填。 :::
type UpdateSubtitleTranscodePresetBodySourceLanguage ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBodySourceLanguage struct {
// REQUIRED; 是否展示原文字幕,取值及含义如下所示。
// * true:展示,此时将展示原文和译文双语字幕
// * false:不展示,此时将只展示译文字幕。
// :::tip 原文字幕语言和译文字幕语言相同时,仅展示译文字幕。 :::
Display bool `json:"Display"`
// REQUIRED; 原文字幕的字体,原文字幕字体根据原文字幕语言取值不同而不同,取值及含义如下所示。
// * 当原文字幕的语言是 zh 时,支持以下字体取值。 * siyuanheiti:思源黑体;
// * songtixi:宋体细;
// * songticu:宋体粗;
// * heitifan:黑体繁;
// * kaiti:楷体。
//
//
// * 当原文字幕的语言是 en 时,支持以下字体取值。 * inter:Inter;
// * roboto:Roboto;
// * opposans:OPPOSans;
// * siyuansongti:思源宋体;
// * montserrat:Montserrat。
//
//
// * 当原文字幕的语言是 ko 和 ja 时,支持 notosans(Noto Sans) 字体。
Font string `json:"Font"`
// REQUIRED; 原文字幕的字体颜色,支持以下几种方法进行定义。
// * 支持以 0x 或 # 开头,后面跟着十六进制颜色 RGB 值,再跟着 @+十六进制/百分比来表示的透明度值,来定义字幕的字体颜色。例如,设置 RGB 值为 FF0000,透明度为 5%的颜色时,您可以传入 0xFF0000@0x80、0xFF0000@0.5、#FF0000@0x80
// 或 #FF0000@0.5。
// * 支持使用前端框架 FFmpeg 规定的颜色关键字,来定义字幕的字体颜色。例如,AliceBlue 表示 0xF0F8FF、AntiqueWhite 表示 0xFAEBD7、Black 表示 0x000000 等。 :::tip 查看详细颜色定义方法及更多颜色关键字,请参考
// FFmpeg 的颜色定义语法
// [https://ffmpeg.org/ffmpeg-utils.html#color-syntax]。 :::
FontColor string `json:"FontColor"`
// REQUIRED; 原文字幕的语言,取值及含义如下所示。
// * zh:中英混合;
// * en:英语;
// * ko:韩语;
// * ja:日语。
Language string `json:"Language"`
// 原文字幕的阴影配置。
Border *UpdateSubtitleTranscodePresetBodySourceLanguageBorder `json:"Border,omitempty"`
// 原文字幕的字体大小,单位为 px,默认为空。 :::tip
// * 使用了预设配置时,字幕字体大小设置不生效。
// * 不使用预设配置时,字幕字体大小为必选参数。 :::
FontSize *int32 `json:"FontSize,omitempty"`
}
UpdateSubtitleTranscodePresetBodySourceLanguage - 原文字幕展示参数配置。
type UpdateSubtitleTranscodePresetBodySourceLanguageBorder ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBodySourceLanguageBorder struct {
// REQUIRED; 描边的颜色,支持以下几种方法进行定义。
// * 支持以 0x 或 # 开头,后面跟着十六进制颜色 RGB 值,再跟着 @+十六进制/百分比来表示的透明度值,来定义字幕的字体颜色。例如,设置 RGB 值为 FF0000,透明度为 5%的颜色时,您可以传入 0xFF0000@0x80、0xFF0000@0.5、#FF0000@0x80
// 或 #FF0000@0.5。
// * 支持使用前端框架 FFmpeg 规定的颜色关键字,来定义字幕的字体颜色。例如,AliceBlue 表示 0xF0F8FF、AntiqueWhite 表示 0xFAEBD7、Black 表示 0x000000 等。 :::tip 查看详细颜色定义方法及更多颜色关键字,请参考
// FFmpeg 的颜色定义语法
// [https://ffmpeg.org/ffmpeg-utils.html#color-syntax]。 :::
Color string `json:"Color"`
// 填0的时候后端根据字体大小进行计算,字体大小/32*1.25
Width *int32 `json:"Width,omitempty"`
}
UpdateSubtitleTranscodePresetBodySourceLanguageBorder - 原文字幕的阴影配置。
type UpdateSubtitleTranscodePresetBodyTargetLanguageItem ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBodyTargetLanguageItem struct {
// REQUIRED; 译文字幕的字体,译文字幕字体根据译文字幕语言取值不同而不同,取值及含义如下所示。
// * 当译文字幕的语言是 zh 时,支持以下字体取值。 * siyuanheiti:思源黑体;
// * songtixi:宋体细;
// * songticu:宋体粗;
// * heitifan:黑体繁;
// * kaiti:楷体。
//
//
// * 当译文字幕的语言是 zh-Hant 时,支持 siyuanheiti (思源黑体)字体。
// * 当译文字幕的语言是 en 时,支持以下字体取值。 * inter:Inter;
// * roboto:Roboto;
// * opposans:OPPOSans;
// * siyuansongti:思源宋体;
// * montserrat:Montserrat。
//
//
// * 当译文字幕的语言是 ko、ja、ar、de、es、fr、hi、pt、 ru、 vi、 th 时,支持 notosans(Noto Sans) 字体。
Font string `json:"Font"`
// REQUIRED; 译文字幕的字体颜色,支持以下几种方法进行定义。
// * 支持以 0x 或 # 开头,后面跟着十六进制颜色 RGB 值,再跟着 @+十六进制/百分比来表示的透明度值,来定义字幕的字体颜色。例如,设置 RGB 值为 FF0000,透明度为 5%的颜色时,您可以传入 0xFF0000@0x80、0xFF0000@0.5、#FF0000@0x80
// 或 #FF0000@0.5。
// * 支持使用前端框架 FFmpeg 规定的颜色关键字,来定义字幕的字体颜色。例如,AliceBlue 表示 0xF0F8FF、AntiqueWhite 表示 0xFAEBD7、Black 表示 0x000000 等。 :::tip 查看详细颜色定义方法及更多颜色关键字,请参考
// FFmpeg 的颜色定义语法
// [https://ffmpeg.org/ffmpeg-utils.html#color-syntax]。 :::
FontColor string `json:"FontColor"`
// REQUIRED; 译文字幕的语言,取值及含义如下所示。
// * zh:中英混合;
// * zh-Hant:繁体中文;
// * en:英语;
// * ko:韩语;
// * ja:日语;
// * ar:阿拉伯语;
// * de:德语;
// * es:西班牙语;
// * fr:法语;
// * hi:印地语;
// * pt:葡萄牙语;
// * ru:俄语;
// * vi:越南语;
// * th:泰语。
Language string `json:"Language"`
// 填0的时候后端根据字体大小进行计算,字体大小/32*1.25
Border *UpdateSubtitleTranscodePresetBodyTargetLanguageItemBorder `json:"Border,omitempty"`
// 译文字幕的字体大小,单位为 px,默认为空。 :::tip
// * 使用预设配置时,字幕字体大小设置不生效。
// * 不使用预设配置时,字幕字体大小为必选参数。 :::
FontSize *int32 `json:"FontSize,omitempty"`
}
type UpdateSubtitleTranscodePresetBodyTargetLanguageItemBorder ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetBodyTargetLanguageItemBorder struct {
// REQUIRED
Color string `json:"Color"`
Width *int32 `json:"Width,omitempty"`
}
UpdateSubtitleTranscodePresetBodyTargetLanguageItemBorder - 填0的时候后端根据字体大小进行计算,字体大小/32*1.25
type UpdateSubtitleTranscodePresetQuery ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetQuery struct{}
type UpdateSubtitleTranscodePresetReq ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetReq struct {
*UpdateSubtitleTranscodePresetQuery
*UpdateSubtitleTranscodePresetBody
}
type UpdateSubtitleTranscodePresetRes ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetRes struct {
// REQUIRED
ResponseMetadata UpdateSubtitleTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateSubtitleTranscodePresetResResponseMetadata ¶ added in v1.0.32
type UpdateSubtitleTranscodePresetResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestID为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateTimeShiftPresetV2 ¶
type UpdateTimeShiftPresetV2 struct{}
type UpdateTimeShiftPresetV2Body ¶
type UpdateTimeShiftPresetV2Body struct {
// REQUIRED
App string `json:"App"`
// REQUIRED
MaxShiftTime int32 `json:"MaxShiftTime"`
// REQUIRED
Preset string `json:"Preset"`
// REQUIRED
Type string `json:"Type"`
// REQUIRED
Vhost string `json:"Vhost"`
MasterFormat *string `json:"MasterFormat,omitempty"`
Status *int32 `json:"Status,omitempty"`
}
type UpdateTimeShiftPresetV2Query ¶
type UpdateTimeShiftPresetV2Query struct{}
type UpdateTimeShiftPresetV2Req ¶
type UpdateTimeShiftPresetV2Req struct {
*UpdateTimeShiftPresetV2Query
*UpdateTimeShiftPresetV2Body
}
type UpdateTimeShiftPresetV2Res ¶
type UpdateTimeShiftPresetV2Res struct {
// REQUIRED
ResponseMetadata UpdateTimeShiftPresetV2ResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateTimeShiftPresetV2ResResponseMetadata ¶
type UpdateTimeShiftPresetV2ResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateTimeShiftPresetV2ResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type UpdateTranscodePreset ¶
type UpdateTranscodePreset struct{}
type UpdateTranscodePresetBody ¶
type UpdateTranscodePresetBody struct {
// REQUIRED; 转码配置的名称,您可以调用ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853]接口查看待更新转码配置的Preset取值。
Preset string `json:"Preset"`
// REQUIRED; 域名空间,您可以调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853] 接口查看待更新转码配置的 Vhost 取值。
Vhost string `json:"Vhost"`
ALayout *string `json:"ALayout,omitempty"`
AProfile *string `json:"AProfile,omitempty"`
AR *int32 `json:"AR,omitempty"`
AbrMode *int32 `json:"AbrMode,omitempty"`
AccountID *string `json:"AccountID,omitempty"`
// 音频编码格式,默认值为aac,支持的取值及含义如下所示。
// * aac:使用 AAC 音频编码格式;
// * opus:使用 Opus 音频编码格式。
// * copy:不进行音频转码,所有音频编码参数不生效,音频编码参数包括音频码率(AudioBitrate)等。
Acodec *string `json:"Acodec,omitempty"`
AdvancedParam *string `json:"AdvancedParam,omitempty"`
AllowAudioCopy *int32 `json:"AllowAudioCopy,omitempty"`
AllowVideoCopy *int32 `json:"AllowVideoCopy,omitempty"`
An *int32 `json:"An,omitempty"`
// 应用名称,取值与直播流地址的 AppName 字段取值相同,您可以调用 ListVhostTransCodePreset [https://www.volcengine.com/docs/6469/1126853] 接口查看待更新转码配置的
// App 取值。
App *string `json:"App,omitempty"`
// 视频分辨率自适应模式开关,默认值为 0。支持的取值及含义如下。
// * 0:关闭视频分辨率自适应;
// * 1:开启视频分辨率自适应。 :::tip
// * 关闭视频分辨率自适应模式(As 取值为 0)时,转码配置的视频分辨率取视频宽度(Width)和视频高度(Height)的值对转码视频进行拉伸;
// * 开启视频分辨率自适应模式(As 取值为 1)时,转码配置的视频分辨率按照短边长度(ShortSide)、长边长度(LongSide)、视频宽度(Width)、视频高度(Height)的优先级取值,另一边等比缩放。 :::
As *string `json:"As,omitempty"`
// 音频码率,单位为 kbps,默认值为128,取值范围为 [0,1000];取值为0时,表示与源流的音频码率相同。
AudioBitrate *int32 `json:"AudioBitrate,omitempty"`
AutoTransAb *int32 `json:"AutoTransAb,omitempty"`
AutoTransAl *int32 `json:"AutoTransAl,omitempty"`
AutoTransAr *int32 `json:"AutoTransAr,omitempty"`
// 是否开启转码视频分辨率不超过源流分辨率,默认值为 1 表示开启。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransResolution *int32 `json:"AutoTransResolution,omitempty"`
// 是否开启转码视频码率不超过源流码率,默认值为 1 表示开启。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVb *int32 `json:"AutoTransVb,omitempty"`
// 是否开启转码视频帧率不超过源流帧率,默认值为 1 表示开启。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码。
// * 0:关闭;
// * 1:开启。
AutoTransVr *int32 `json:"AutoTransVr,omitempty"`
BCM *int32 `json:"BCM,omitempty"`
// 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 3,取值为 0 时表示去除 B 帧。
// 最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。
// * 视频编码格式为 H.264 (Vcodec 取值为 h264)时取值范围为 [0,7];
// * 视频编码格式为 H.265 或 H.266 (Vcodec 取值为 h265 或 h266)时取值范围为 [0,3]、7、15。
BFrames *int32 `json:"BFrames,omitempty"`
Describe *string `json:"Describe,omitempty"`
// 动态范围,画质增强类型生效
// * SDR:输出为SDR
// * HDR:输出为HDR
DynamicRange *string `json:"DynamicRange,omitempty"`
// 是否开启智能插帧,只对画质增强类型生效
// * 0:不开启
// * 1:开启
FISwitch *int32 `json:"FISwitch,omitempty"`
// 视频帧率,单位为 fps,默认值为 25,取值为 0 时表示与源流视频帧率相同。
// 视频帧率的取值范围根据视频编码格式(Vcodec)的不同有所差异,视频码率的取值范围如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,视频帧率取值范围为 [0,60];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,视频帧率取值范围为 [0,35]。
FPS *int32 `json:"FPS,omitempty"`
// IDR 帧之间的最大间隔时间,单位为秒,默认值为 4,取值范围为 [1,20]。
GOP *int32 `json:"GOP,omitempty"`
GopMin *int32 `json:"GopMin,omitempty"`
HVSPre *bool `json:"HVSPre,omitempty"`
// 视频高度,默认值为 0。
// 视频高度的取值范围根据视频编码格式(Vcodec)的不同所有差异,视频高度取值如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,取值范围为 [150,1920];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,不支持设置 Width 和 Height。
// :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Height *int32 `json:"Height,omitempty"`
// 长边长度,默认值为 0。配置不同的转码类型(Roi)和视频编码方式(Vcodec)时,短边长度的取值范围存在如下。
// * 转码类型为标准转码(Roi 取值为 false)时: * 视频编码方式为 H.264 (Vcodec 取值为 h264)时取值范围为 0 和 [150,4096];
// * 视频编码方式为 H.265 (Vcodec 取值为 h265)时取值范围为 0 和 [150,7680];
// * 视频编码方式为 H.266 (Vcodec 取值为 h266)时取值范围为 0 和 [150,1280]。
//
//
// * 转码类型为极智超清转码(Roi 取值为 true)时: * 视频编码方式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时取值范围为 0 和 [150,1920]。
//
//
// :::tip
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,参数生效,反之则不生效。
// * 当开启视频分辨率自适应模式时(As 取值为 1)时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
LongSide *int32 `json:"LongSide,omitempty"`
LookAhead *int32 `json:"LookAhead,omitempty"`
Modifier *string `json:"Modifier,omitempty"`
NvBf *int32 `json:"NvBf,omitempty"`
NvCodec *string `json:"NvCodec,omitempty"`
NvGop *int32 `json:"NvGop,omitempty"`
NvHVSPre *bool `json:"NvHVSPre,omitempty"`
NvLookahead *int32 `json:"NvLookahead,omitempty"`
NvPercent *int32 `json:"NvPercent,omitempty"`
NvPreset *string `json:"NvPreset,omitempty"`
NvPriority *int32 `json:"NvPriority,omitempty"`
NvProfile *string `json:"NvProfile,omitempty"`
NvRefs *int32 `json:"NvRefs,omitempty"`
NvTempAQ *int32 `json:"NvTempAQ,omitempty"`
Ocr *bool `json:"Ocr,omitempty"`
// 转码模板参数的类型
// * hvq:表示使用画质增强
// 选择画质增强时,支持使用 shortside 来设置分辨率。
// * ParamType 取 hvq 时: * 视频编码方式为 H.264 (Vcodec 取值为 h264)时,shortside 取值范围为 0 和 [150,1280];
// * 视频编码方式为 H.265 (Vcodec取值为h265)是,shortside 取值范围为 0 和 [150,1280];
ParamType *string `json:"ParamType,omitempty"`
PresetKind *int32 `json:"PresetKind,omitempty"`
PresetType *int32 `json:"PresetType,omitempty"`
Qp *int32 `json:"Qp,omitempty"`
RegionConfig *string `json:"RegionConfig,omitempty"`
Revision *string `json:"Revision,omitempty"`
// 转码类型是否为极智超清转码,默认值为 false,取值及含义如下。
// * true:极智超清转码;
// * false:标准转码。
// :::tip 视频编码格式为 H.266 (Vcodec取值为h266)时,转码类型不支持极智超清转码。 :::
Roi *bool `json:"Roi,omitempty"`
SITI *bool `json:"SITI,omitempty"`
// 使用场景,画质增强时生效
// football:足球场景
SceneType *string `json:"SceneType,omitempty"`
// 短边长度,默认值为 0。配置不同的转码类型(Roi)和视频编码方式(Vcodec)时,短边长度的取值范围存在如下。
// * 转码类型为标准转码(Roi 取值为 false)时: * 视频编码方式为 H.264 (Vcodec 取值为 h264)时取值范围为 0 和 [150,2160];
// * 视频编码方式为 H.265 (Vcodec 取值为 h265)时取值范围为 0 和 [150,4096];
// * 视频编码方式为 H.266 (Vcodec 取值为 h266)时取值范围为 0 和 [150,720]。
//
//
// * 转码类型为极智超清转码(Roi 取值为 true)时: * 视频编码方式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时取值范围为 0 和 [150,1920]。 :::tip
//
//
// * 当开启视频分辨率自适应模式(As 取值为 1)时,参数生效,反之则不生效。
// * 当开启视频分辨率自适应模式(As 取值为 1)时,如果 LongSide 、 ShortSide 、Width 、Height 同时取 0,表示保持源流尺寸。 :::
ShortSide *int32 `json:"ShortSide,omitempty"`
Status *int32 `json:"Status,omitempty"`
// 转码停止时长,支持触发方式为拉流转码(TransType 取值为 Pull)时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 -1 和 [0,300],-1 表示不停止转码,默认值为 60。
StopInterval *int32 `json:"StopInterval,omitempty"`
// 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
// 转码后缀通常以流名称后缀的形式来使用,常见的标识有 _sd、_hd、_uhd,例如,当转码配置的标识为 _hd 时,拉取转码流时转码流的流名名称为 源流的流名称_hd。
SuffixName *string `json:"SuffixName,omitempty"`
Threads *int32 `json:"Threads,omitempty"`
// 转码触发方式,默认值为 Pull,支持的取值及含义如下。
// * Push:推流转码,直播推流后会自动启动转码任务,生成转码流;
// * Pull:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。
TransType *string `json:"TransType,omitempty"`
TranscodeStruct *UpdateTranscodePresetBodyTranscodeStruct `json:"TranscodeStruct,omitempty"`
VBRatio *int32 `json:"VBRatio,omitempty"`
VBVBufSize *int32 `json:"VBVBufSize,omitempty"`
VBVMaxRate *int32 `json:"VBVMaxRate,omitempty"`
VLevel *string `json:"VLevel,omitempty"`
VPreset *string `json:"VPreset,omitempty"`
VProfile *string `json:"VProfile,omitempty"`
VR *int32 `json:"VRVr,omitempty"`
VRBBframes *int32 `json:"VRBBframes,omitempty"`
VRBHeightNum *int32 `json:"VRBHeightNum,omitempty"`
VRBPreset *string `json:"VRBPreset,omitempty"`
VRBProfile *string `json:"VRBProfile,omitempty"`
VRBSuffix *string `json:"VRBSuffix,omitempty"`
VRBVb *int32 `json:"VRBVb,omitempty"`
VRBWidthNum *int32 `json:"VRBWidthNum,omitempty"`
VRGop *int32 `json:"VRGop,omitempty"`
VRGopDen *int32 `json:"VRGopDen,omitempty"`
VRHvspre *string `json:"VRHvspre,omitempty"`
VRProjection *string `json:"VRProjection,omitempty"`
VRRoi *string `json:"VRRoi,omitempty"`
VRTBframes *int32 `json:"VRTBframes,omitempty"`
VRTPreset *string `json:"VRTPreset,omitempty"`
VRTProfile *string `json:"VRTProfile,omitempty"`
VRTSuffix *string `json:"VRTSuffix,omitempty"`
VRTVb *int32 `json:"VRTVb,omitempty"`
VRTileMod *int32 `json:"VRTileMod,omitempty"`
VRateCtrl *string `json:"VRateCtrl,omitempty"`
VbThreshold *string `json:"VbThreshold,omitempty"`
Vclass *bool `json:"Vclass,omitempty"`
// 视频编码格式,支持的取值及含义如下所示。
// * h264:使用 H.264 视频编码格式;
// * h265:使用 H.265 视频编码格式;
// * h266:使用 H.266 视频编码格式;
// * copy:不进行视频转码,所有视频编码参数不生效,视频编码参数包括视频帧率(FPS)、视频码率(VideoBitrate)、分辨率设置(As、Width、Height、ShortSide、LongSide)、GOP 和 BFrames
// 等。
Vcodec *string `json:"Vcodec,omitempty"`
// 视频码率,单位为 bps,默认值为 1000000;取值为 0 时,表示与源流的视频码率相同。
// 视频码率的取值范围根据视频编码格式(Vcodec)的不同有所差异,视频码率的取值范围如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,视频码率取值范围为 [0,30000000];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,视频码率取值范围为 [0,6000000]。
VideoBitrate *int32 `json:"VideoBitrate,omitempty"`
Vn *int32 `json:"Vn,omitempty"`
Watermark *string `json:"Watermark,omitempty"`
// 视频宽度,单位为 px,默认值为 0。
// 视频宽度的取值范围根据视频编码格式(Vcodec)的不同所有差异,视频宽度取值如下所示。
// * 视频编码格式为 H.264 或 H.265 (Vcodec 取值为 h264 或 h265)时,取值范围为 [150,1920];
// * 视频编码格式为 H.266 (Vcodec 取值为 h266)时,不支持设置 Width 和 Height。
// :::tip
// * 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸;
// * 当关闭视频分辨率自适应(As 取值为 0)时,Width 和 Height 任一取值为 0 时,转码视频将保持源流尺寸。 :::
Width *int32 `json:"Width,omitempty"`
}
type UpdateTranscodePresetBodyTranscodeStruct ¶
type UpdateTranscodePresetBodyTranscodeStruct struct {
// Dictionary of
ABTest map[string]*Components1Wv3ClqSchemasUpdatetranscodepresetbodyPropertiesTranscodestructPropertiesAbtestAdditionalproperties `json:"ABTest,omitempty"`
Codec *string `json:"Codec,omitempty"`
PresetName *string `json:"PresetName,omitempty"`
StopInterval *int32 `json:"StopInterval,omitempty"`
Suffix *string `json:"Suffix,omitempty"`
Type *string `json:"Type,omitempty"`
}
type UpdateTranscodePresetQuery ¶
type UpdateTranscodePresetQuery struct{}
type UpdateTranscodePresetReq ¶
type UpdateTranscodePresetReq struct {
*UpdateTranscodePresetQuery
*UpdateTranscodePresetBody
}
type UpdateTranscodePresetRes ¶
type UpdateTranscodePresetRes struct {
// REQUIRED
ResponseMetadata UpdateTranscodePresetResResponseMetadata `json:"ResponseMetadata"`
// Anything
Result interface{} `json:"Result,omitempty"`
}
type UpdateTranscodePresetResResponseMetadata ¶
type UpdateTranscodePresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateTranscodePresetResResponseMetadataError `json:"Error,omitempty"`
RequestID *string `json:"RequestID,omitempty"`
}
type UpdateUserAgentAccessRule ¶ added in v1.0.28
type UpdateUserAgentAccessRule struct{}
type UpdateUserAgentAccessRuleBody ¶ added in v1.0.28
type UpdateUserAgentAccessRuleBody struct {
// REQUIRED
UaAccessRule UpdateUserAgentAccessRuleBodyUaAccessRule `json:"UaAccessRule"`
// REQUIRED
Vhost string `json:"Vhost"`
Domain *string `json:"Domain,omitempty"`
}
type UpdateUserAgentAccessRuleBodyUaAccessRule ¶ added in v1.0.28
type UpdateUserAgentAccessRuleQuery ¶ added in v1.0.28
type UpdateUserAgentAccessRuleQuery struct{}
type UpdateUserAgentAccessRuleReq ¶ added in v1.0.28
type UpdateUserAgentAccessRuleReq struct {
*UpdateUserAgentAccessRuleQuery
*UpdateUserAgentAccessRuleBody
}
type UpdateUserAgentAccessRuleRes ¶ added in v1.0.28
type UpdateUserAgentAccessRuleRes struct {
// REQUIRED
ResponseMetadata UpdateUserAgentAccessRuleResResponseMetadata `json:"ResponseMetadata"`
// 视请求的接口而定
Result interface{} `json:"Result,omitempty"`
}
type UpdateUserAgentAccessRuleResResponseMetadata ¶ added in v1.0.28
type UpdateUserAgentAccessRuleResResponseMetadata struct {
// REQUIRED; 请求的接口名,属于请求的公共参数。
Action string `json:"Action"`
// REQUIRED; 请求的Region,例如:cn-north-1
Region string `json:"Region"`
// REQUIRED; RequestId为每次API请求的唯一标识。
RequestID string `json:"RequestId"`
// REQUIRED; 请求的服务,属于请求的公共参数。
Service string `json:"Service"`
// REQUIRED; 请求的版本号,属于请求的公共参数。
Version string `json:"Version"`
}
type UpdateWatermarkPreset ¶
type UpdateWatermarkPreset struct{}
type UpdateWatermarkPresetBody ¶
type UpdateWatermarkPresetBody struct {
// REQUIRED; 应用名称,您可以调用ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889]接口,查看待更新水印配置的 App 取值。
App string `json:"App"`
// REQUIRED; 域名空间,您可以调用 ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889] 接口,查看待更新水印配置的 Vhost 取值。
Vhost string `json:"Vhost"`
// 直播画面方向,支持 2 种取值。
// * vertical:竖屏;
// * horizontal:横屏。 :::tip 该参数属于历史版本参数,预计将于未来移除。建议使用预览背景高度(PreviewHeight)、预览背景宽度(PreviewWidth)参数代替。 :::
Orientation *string `json:"Orientation,omitempty"`
// 水印图片编码字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片使用 data URI 协议,格式为:data:[<mediatype>];[base64],<data>。
// * mediatype:图片类型,支持 png、jpg、jpeg 格式;
// * data:base64 编码的图片字符串。
// :::warning 如果水印图片不更新,请勿在更新配置时传入该参数,否则会造成水印无法显示。 :::
Picture *string `json:"Picture,omitempty"`
// 水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入。同时传入时,以水印图片编码字符串参数为准。 :::warning 如果水印图片不更新,请勿在更新配置时传入该参数,否则会造成水印无法显示。 :::
PictureURL *string `json:"PictureUrl,omitempty"`
// 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]。
PosX *float32 `json:"PosX,omitempty"`
// 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]。
PosY *float32 `json:"PosY,omitempty"`
// 水印图片预览背景高度,单位为 px。
PreviewHeight *float32 `json:"PreviewHeight,omitempty"`
// 水印图片预览背景宽度,单位为 px。
PreviewWidth *float32 `json:"PreviewWidth,omitempty"`
// 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。与水印相对宽度字段冲突,请选择其中一个传参。
RelativeHeight *float32 `json:"RelativeHeight,omitempty"`
// 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。与水印相对高度字段冲突,请选择其中一个传参。
RelativeWidth *float32 `json:"RelativeWidth,omitempty"`
// 流名称,您可以调用ListVhostWatermarkPreset [https://www.volcengine.com/docs/6469/1126889]接口,查看待更新水印配置的 Stream 取值。
Stream *string `json:"Stream,omitempty"`
}
type UpdateWatermarkPresetQuery ¶
type UpdateWatermarkPresetQuery struct{}
type UpdateWatermarkPresetReq ¶
type UpdateWatermarkPresetReq struct {
*UpdateWatermarkPresetQuery
*UpdateWatermarkPresetBody
}
type UpdateWatermarkPresetRes ¶
type UpdateWatermarkPresetRes struct {
// REQUIRED
ResponseMetadata UpdateWatermarkPresetResResponseMetadata `json:"ResponseMetadata"`
}
type UpdateWatermarkPresetResResponseMetadata ¶
type UpdateWatermarkPresetResResponseMetadata struct {
// REQUIRED
Action string `json:"Action"`
// REQUIRED
Region string `json:"Region"`
// REQUIRED
RequestID string `json:"RequestId"`
// REQUIRED
Service string `json:"Service"`
// REQUIRED
Version string `json:"Version"`
Error *UpdateWatermarkPresetResResponseMetadataError `json:"Error,omitempty"`
}