diff options
Diffstat (limited to 'data/zh_cn/ice/2020-11-09/api-docs.php')
| -rw-r--r-- | data/zh_cn/ice/2020-11-09/api-docs.php | 76288 |
1 files changed, 76288 insertions, 0 deletions
diff --git a/data/zh_cn/ice/2020-11-09/api-docs.php b/data/zh_cn/ice/2020-11-09/api-docs.php new file mode 100644 index 0000000..536ec49 --- /dev/null +++ b/data/zh_cn/ice/2020-11-09/api-docs.php @@ -0,0 +1,76288 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ICE', + 'version' => '2020-11-09', + ], + 'directories' => [ + [ + 'id' => 170098, + 'title' => '媒体上传', + 'type' => 'directory', + 'children' => [ + 'CreateUploadMedia', + 'CreateUploadStream', + 'RefreshUploadMedia', + 'RegisterMediaStream', + 'GetUrlUploadInfos', + 'UploadMediaByURL', + 'UploadStreamByURL', + ], + ], + [ + 'id' => 170106, + 'title' => '媒资管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 186460, + 'title' => '媒资搜索', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 277535, + 'title' => '流媒资操作', + 'type' => 'directory', + 'children' => [ + 'CloseStreamToSearchLib', + 'GetStreamTagList', + 'CreateStreamToSearchLib', + 'AddStreamTagToSearchLib', + ], + ], + [ + 'id' => 186506, + 'title' => '搜索库管理', + 'type' => 'directory', + 'children' => [ + 'CreateSearchLib', + 'QuerySearchLib', + 'ListSearchLib', + 'AlterSearchLib', + 'DropSearchLib', + ], + ], + [ + 'id' => 186510, + 'title' => '搜索索引配置管理', + 'type' => 'directory', + 'children' => [ + 'CreateSearchIndex', + 'AlterSearchIndex', + 'QuerySearchIndex', + 'DropSearchIndex', + ], + ], + [ + 'id' => 205155, + 'title' => '搜索索引任务管理', + 'type' => 'directory', + 'children' => [ + 'QueryMediaIndexJob', + 'SearchIndexJobRerun', + ], + ], + [ + 'id' => 205156, + 'title' => '媒资操作', + 'type' => 'directory', + 'children' => [ + 'InsertMediaToSearchLib', + 'UpdateMediaToSearchLib', + 'DeleteMediaFromSearchLib', + ], + ], + [ + 'id' => 205157, + 'title' => '搜索功能', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 205158, + 'title' => '基础搜索', + 'type' => 'directory', + 'children' => [ + 'SearchMedia', + 'GetVideoList', + ], + ], + [ + 'id' => 205159, + 'title' => '人脸搜索', + 'type' => 'directory', + 'children' => [ + 'SearchMediaByFace', + 'SearchMediaClipByFace', + ], + ], + [ + 'id' => 205160, + 'title' => '智能标签搜索', + 'type' => 'directory', + 'children' => [ + 'SearchMediaByAILabel', + ], + ], + [ + 'id' => 205161, + 'title' => '大模型搜索', + 'type' => 'directory', + 'children' => [ + 'SearchMediaByMultimodal', + 'SearchMediaByHybrid', + ], + ], + ], + ], + ], + ], + [ + 'id' => 137519, + 'title' => '媒资库', + 'type' => 'directory', + 'children' => [ + 'RegisterMediaInfo', + 'GetMediaInfo', + 'UpdateMediaInfo', + 'DeleteMediaInfos', + 'BatchGetMediaInfos', + 'ListMediaBasicInfos', + 'ListPublicMediaBasicInfos', + 'ListAllPublicMediaTags', + 'SubmitMediaAiAnalysisJob', + ], + ], + [ + 'id' => 170110, + 'title' => '分类管理', + 'type' => 'directory', + 'children' => [ + 'AddCategory', + 'GetCategories', + 'UpdateCategory', + 'DeleteCategory', + ], + ], + [ + 'id' => 179222, + 'title' => '标记管理', + 'type' => 'directory', + 'children' => [ + 'AddMediaMarks', + 'GetMediaMarks', + 'UpdateMediaMarks', + 'DeleteMediaMarks', + 'ListMediaMarks', + ], + ], + [ + 'id' => 357427, + 'title' => 'IPC管理', + 'type' => 'directory', + 'children' => [ + 'CreateIpcOrder', + 'GetIpcDeviceInfo', + 'QueryIpcQuota', + ], + ], + 'GetPlayInfo', + 'DeletePlayInfo', + ], + ], + [ + 'id' => 174129, + 'title' => '媒资审核', + 'type' => 'directory', + 'children' => [ + 'CreateAudit', + 'SubmitMediaCensorJob', + 'QueryMediaCensorJobDetail', + 'QueryMediaCensorJobList', + ], + ], + [ + 'id' => 170115, + 'title' => '配置管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170116, + 'title' => '模板管理', + 'type' => 'directory', + 'children' => [ + 'CreateCustomTemplate', + 'GetSystemTemplate', + 'GetCustomTemplate', + 'SetDefaultCustomTemplate', + 'UpdateCustomTemplate', + 'DeleteCustomTemplate', + 'ListSystemTemplates', + 'ListCustomTemplates', + ], + ], + [ + 'id' => 170125, + 'title' => '管道管理', + 'type' => 'directory', + 'children' => [ + 'CreatePipeline', + 'GetPipeline', + 'UpdatePipeline', + 'DeletePipeline', + 'ListPipelines', + ], + ], + ], + ], + [ + 'id' => 170131, + 'title' => '媒体处理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 170132, + 'title' => '转码接口', + 'type' => 'directory', + 'children' => [ + 'SubmitTranscodeJob', + 'GetTranscodeJob', + 'ListTranscodeJobs', + 'SubmitPackageJob', + 'GetPackageJob', + 'ListPackageJobs', + 'GenerateKMSDataKey', + 'DecryptKMSDataKey', + ], + ], + [ + 'id' => 170136, + 'title' => '截图接口', + 'type' => 'directory', + 'children' => [ + 'SubmitSnapshotJob', + 'SubmitDynamicImageJob', + 'GetSnapshotUrls', + 'GetSnapshotJob', + 'GetDynamicImageJob', + 'ListSnapshotJobs', + 'ListDynamicImageJobs', + ], + ], + [ + 'id' => 170144, + 'title' => '媒体信息接口', + 'type' => 'directory', + 'children' => [ + 'SubmitSyncMediaInfoJob', + 'SubmitMediaInfoJob', + 'GetMediaInfoJob', + 'ListMediaInfoJobs', + ], + ], + ], + ], + [ + 'id' => 171061, + 'title' => '实时处理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 171331, + 'title' => '实时媒体转码', + 'type' => 'directory', + 'children' => [ + 'CreateLiveTranscodeTemplate', + 'GetLiveTranscodeTemplate', + 'UpdateLiveTranscodeTemplate', + 'DeleteLiveTranscodeTemplate', + 'ListLiveTranscodeTemplates', + 'SubmitLiveTranscodeJob', + 'SendLiveTranscodeJobCommand', + 'GetLiveTranscodeJob', + 'UpdateLiveTranscodeJob', + 'DeleteLiveTranscodeJob', + 'ListLiveTranscodeJobs', + ], + ], + [ + 'id' => 171062, + 'title' => '实时媒体录制', + 'type' => 'directory', + 'children' => [ + 'CreateLiveRecordTemplate', + 'GetLiveRecordTemplate', + 'UpdateLiveRecordTemplate', + 'DeleteLiveRecordTemplate', + 'ListLiveRecordTemplates', + 'SubmitLiveRecordJob', + 'GetLiveRecordJob', + 'DeleteLiveRecordFiles', + 'ListLiveRecordJobs', + 'ListLiveRecordFiles', + ], + ], + [ + 'id' => 171234, + 'title' => '实时媒体截图', + 'type' => 'directory', + 'children' => [ + 'CreateLiveSnapshotTemplate', + 'GetLiveSnapshotTemplate', + 'UpdateLiveSnapshotTemplate', + 'DeleteLiveSnapshotTemplate', + 'ListLiveSnapshotTemplates', + 'SubmitLiveSnapshotJob', + 'SendLiveSnapshotJobCommand', + 'GetLiveSnapshotJob', + 'DeleteLiveSnapshotFiles', + 'ListLiveSnapshotJobs', + 'ListLiveSnapshotFiles', + ], + ], + ], + ], + [ + 'id' => 170149, + 'title' => '生产制作', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 137503, + 'title' => '云剪辑工程管理', + 'type' => 'directory', + 'children' => [ + 'CreateEditingProject', + 'GetEditingProject', + 'UpdateEditingProject', + 'DeleteEditingProjects', + 'ListEditingProjects', + 'AddEditingProjectMaterials', + 'GetEditingProjectMaterials', + 'DeleteEditingProjectMaterials', + 'GetLiveEditingIndexFile', + 'SubmitProjectExportJob', + 'GetProjectExportJob', + ], + ], + [ + 'id' => 137513, + 'title' => '剪辑制作', + 'type' => 'directory', + 'children' => [ + 'SubmitMediaProducingJob', + 'GetMediaProducingJob', + 'SubmitLiveEditingJob', + 'GetLiveEditingJob', + 'SubmitBatchMediaProducingJob', + 'GetBatchMediaProducingJob', + 'SubmitSportsHighlightsJob', + 'SubmitScreenMediaHighlightsJob', + 'ListMediaProducingJobs', + 'ListBatchMediaProducingJobs', + ], + ], + [ + 'id' => 137528, + 'title' => '模板工厂', + 'type' => 'directory', + 'children' => [ + 'AddTemplate', + 'GetTemplate', + 'UpdateTemplate', + 'DeleteTemplate', + 'ListTemplates', + 'GetTemplateMaterials', + 'GetTemplateParams', + ], + ], + [ + 'id' => 137534, + 'title' => '智能任务', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 208842, + 'title' => '热词管理', + 'type' => 'directory', + 'children' => [ + 'DeleteHotwordLibrary', + 'GetHotwordLibrary', + 'ListHotwordLibraries', + 'UpdateHotwordLibrary', + 'CreateHotwordLibrary', + ], + ], + [ + 'id' => 185311, + 'title' => '数字人训练', + 'type' => 'directory', + 'children' => [ + 'CreateAvatarTrainingJob', + 'UpdateAvatarTrainingJob', + 'SubmitAvatarTrainingJob', + 'GetAvatarTrainingJob', + 'DeleteAvatarTrainingJob', + 'ListAvatarTrainingJobs', + 'GetAvatar', + 'ListAvatars', + ], + ], + [ + 'id' => 183347, + 'title' => '人声克隆', + 'type' => 'directory', + 'children' => [ + 'CreateCustomizedVoiceJob', + 'GetDemonstrationForCustomizedVoiceJob', + 'DetectAudioForCustomizedVoiceJob', + 'SubmitCustomizedVoiceJob', + 'SubmitStandardCustomizedVoiceJob', + 'GetCustomizedVoiceJob', + 'DeleteCustomizedVoiceJob', + 'ListCustomizedVoiceJobs', + 'GetCustomizedVoice', + 'UpdateCustomizedVoice', + 'ListCustomizedVoices', + ], + ], + 'SubmitASRJob', + 'SubmitAvatarVideoJob', + 'SubmitAudioProduceJob', + 'SubmitTextGenerateJob', + 'SubmitVideoTranslationJob', + 'SubmitHighlightExtractionJob', + 'SubmitSegmentationJob', + 'GetSmartHandleJob', + 'DeleteSmartJob', + 'ListSmartJobs', + 'ListSmartSysAvatarModels', + 'ListSmartVoiceGroups', + ], + ], + ], + ], + [ + 'id' => 194835, + 'title' => 'AI实时互动', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 196322, + 'title' => '智能体管理', + 'type' => 'directory', + 'children' => [ + 'StartAIAgentInstance', + 'StopAIAgentInstance', + 'UpdateAIAgentInstance', + 'DescribeAIAgentInstance', + 'ListAIAgentInstance', + 'SendAIAgentSpeech', + 'TakeoverAIAgentCall', + 'SendAIAgentDataChannelMessage', + 'SendAIAgentText', + ], + ], + [ + 'id' => 196323, + 'title' => 'AICallKit集成接口', + 'type' => 'directory', + 'children' => [ + 'GenerateMessageChatToken', + 'GenerateAIAgentCall', + 'ListAIAgentDialogues', + 'DeleteAIAgentDialogue', + 'SendMessageChatText', + ], + ], + [ + 'id' => 208799, + 'title' => '运营商线路接口', + 'type' => 'directory', + 'children' => [ + 'StartAIAgentOutboundCall', + 'ListAIAgentPhoneNumber', + 'ForwardAIAgentCall', + ], + ], + [ + 'id' => 246577, + 'title' => '声纹管理', + 'type' => 'directory', + 'children' => [ + 'SetAIAgentVoiceprint', + 'ClearAIAgentVoiceprint', + 'ListAIAgentVoiceprints', + ], + ], + [ + 'id' => 208802, + 'title' => '离线任务', + 'type' => 'directory', + 'children' => [ + 'SubmitAIAgentVideoAuditTask', + ], + ], + [ + 'id' => 322101, + 'title' => 'RTOS License', + 'type' => 'directory', + 'children' => [ + 'GetAiRtcLicenseInfoList', + 'GetAiRtcAuthCodeList', + 'ActiveAiRtcLicense', + ], + ], + ], + ], + [ + 'id' => 170150, + 'title' => '媒体AI', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 178764, + 'title' => '智能内容理解', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 208941, + 'title' => '任务接口', + 'type' => 'directory', + 'children' => [ + 'SubmitVideoCognitionJob', + 'QueryVideoCognitionJob', + 'QuerySmarttagJob', + 'SubmitSmarttagJob', + ], + ], + [ + 'id' => 208942, + 'title' => '自定义识别实体接口', + 'type' => 'directory', + 'children' => [ + 'CreateRecognitionEntity', + 'CreateRecognitionLib', + 'CreateRecognitionSample', + 'ListRecognitionSamples', + 'DeleteRecognitionSample', + 'ListRecognitionEntities', + 'ListRecognitionLibs', + 'DeleteRecognitionLib', + 'DeleteRecognitionEntity', + ], + ], + ], + ], + [ + 'id' => 178765, + 'title' => '智能生产', + 'type' => 'directory', + 'children' => [ + 'SubmitIProductionJob', + 'QueryIProductionJob', + ], + ], + [ + 'id' => 178766, + 'title' => '媒体DNA', + 'type' => 'directory', + 'children' => [ + 'CreateDNADB', + 'DeleteDNADB', + 'ListDNADB', + 'SubmitDNAJob', + 'CancelDNAJob', + 'DeleteDNAFiles', + 'ListDNAFiles', + 'QueryDNAJobList', + ], + ], + [ + 'id' => 199811, + 'title' => '数字水印', + 'type' => 'directory', + 'children' => [ + 'SubmitCopyrightJob', + 'QueryCopyrightJobList', + 'SubmitCopyrightExtractJob', + 'QueryCopyrightExtractJob', + 'SubmitTraceAbJob', + 'QueryTraceAbJobList', + 'SubmitTraceM3u8Job', + 'QueryTraceM3u8JobList', + 'SubmitTraceExtractJob', + 'QueryTraceExtractJob', + ], + ], + ], + ], + [ + 'id' => 170153, + 'title' => '用量统计', + 'type' => 'directory', + 'children' => [ + 'DescribeMeterImsMediaConvertUHDUsage', + 'DescribeMeterImsMediaConvertUsage', + 'DescribeMeterImsEditUsage', + 'DescribeMeterImsSummary', + 'DescribeMeterImsMpsAiUsage', + ], + ], + [ + 'id' => 137547, + 'title' => '全局配置', + 'type' => 'directory', + 'children' => [ + 'SetEventCallback', + 'GetEventCallback', + ], + ], + [ + 'id' => 178743, + 'title' => '工作流', + 'type' => 'directory', + 'children' => [ + 'StartWorkflow', + 'GetWorkflowTask', + 'ListWorkflowTasks', + 'StartAIWorkflow', + 'StopAIWorkflowTask', + 'GetAIWorkflowTask', + ], + ], + [ + 'id' => 201826, + 'title' => '媒体服务', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 203088, + 'title' => '媒体直播', + 'type' => 'directory', + 'children' => [ + 'CreateMediaLiveInputSecurityGroup', + 'UpdateMediaLiveInputSecurityGroup', + 'GetMediaLiveInputSecurityGroup', + 'ListMediaLiveInputSecurityGroups', + 'DeleteMediaLiveInputSecurityGroup', + 'CreateMediaLiveInput', + 'UpdateMediaLiveInput', + 'GetMediaLiveInput', + 'ListMediaLiveInputs', + 'DeleteMediaLiveInput', + 'CreateMediaLiveChannel', + 'UpdateMediaLiveChannel', + 'GetMediaLiveChannel', + 'ListMediaLiveChannels', + 'DeleteMediaLiveChannel', + 'StartMediaLiveChannel', + 'StopMediaLiveChannel', + ], + ], + [ + 'id' => 202565, + 'title' => '媒体转码', + 'type' => 'directory', + 'children' => [ + 'SubmitMediaConvertJob', + 'GetMediaConvertJob', + 'ListMediaConvertJobs', + ], + ], + [ + 'id' => 201965, + 'title' => '媒体传输', + 'type' => 'directory', + 'children' => [ + 'GetMediaConnectAvailableRegion', + 'ForbidMediaConnectFlowOutput', + 'ResumeMediaConnectFlowOutput', + 'GetMediaConnectFlowAllOutputName', + 'CloseMediaConnectFlowFailover', + 'OpenMediaConnectFlowFailover', + 'UpdateMediaConnectFlowOutput', + 'GetMediaConnectFlowOutput', + 'DeleteMediaConnectFlowOutput', + 'AddMediaConnectFlowOutput', + 'DeleteMediaConnectFlowInput', + 'UpdateMediaConnectFlowInput', + 'GetMediaConnectFlowInput', + 'AddMediaConnectFlowInput', + 'DeleteMediaConnectFlow', + 'UpdateMediaConnectFlowStatus', + 'GetMediaConnectFlow', + 'CreateMediaConnectFlow', + ], + ], + [ + 'id' => 201860, + 'title' => '媒体广告', + 'type' => 'directory', + 'children' => [ + 'AddAdInsertion', + 'UpdateAdInsertion', + 'GetAdInsertion', + 'ListAdInsertions', + 'DeleteAdInsertion', + 'GetSourceLocation', + 'UpdateSourceLocation', + 'DeleteSourceLocation', + 'ListSourceLocations', + 'CreateSourceLocation', + 'UpdateProgram', + 'GetProgram', + 'DeleteChannel', + 'UpdateSource', + 'StartChannel', + 'DeleteProgram', + 'DeleteSource', + 'StopChannel', + 'ListChannels', + 'ListPrograms', + 'GetSource', + 'CreateChannel', + 'ListSchedules', + 'ListSources', + 'ListAlerts', + 'GetChannel', + 'CreateProgram', + 'ListChannelAlerts', + 'CreateSource', + 'UpdateChannel', + ], + ], + [ + 'id' => 201734, + 'title' => '媒体封装', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 201892, + 'title' => '点播封装', + 'type' => 'directory', + 'children' => [ + 'CreateVodPackagingGroup', + 'GetVodPackagingGroup', + 'ListVodPackagingGroups', + 'DeleteVodPackagingGroup', + 'CreateVodPackagingConfiguration', + 'GetVodPackagingConfiguration', + 'ListVodPackagingConfigurations', + 'DeleteVodPackagingConfiguration', + 'CreateVodPackagingAsset', + 'BatchCreateVodPackagingAsset', + 'GetVodPackagingAsset', + 'ListVodPackagingAssets', + 'DeleteVodPackagingAsset', + ], + ], + [ + 'id' => 201735, + 'title' => '直播封装', + 'type' => 'directory', + 'children' => [ + 'CreateLivePackageChannelGroup', + 'UpdateLivePackageChannelGroup', + 'GetLivePackageChannelGroup', + 'ListLivePackageChannelGroups', + 'DeleteLivePackageChannelGroup', + 'CreateLivePackageChannel', + 'UpdateLivePackageChannel', + 'UpdateLivePackageChannelCredentials', + 'GetLivePackageChannel', + 'ListLivePackageChannels', + 'DeleteLivePackageChannel', + 'CreateLivePackageOriginEndpoint', + 'UpdateLivePackageOriginEndpoint', + 'GetLivePackageOriginEndpoint', + 'ListLivePackageOriginEndpoints', + 'DeleteLivePackageOriginEndpoint', + ], + ], + ], + ], + ], + ], + [ + 'id' => 187656, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 193096, + 'title' => '全集配置--deprecated', + 'type' => 'directory', + 'children' => [ + 'SetContentAnalyzeConfig', + 'GetContentAnalyzeConfig', + 'SetDefaultStorageLocation', + 'GetDefaultStorageLocation', + ], + ], + 'DescribePlayList', + [ + 'id' => 137497, + 'title' => '素材中心', + 'type' => 'directory', + 'children' => [ + 'AddFavoritePublicMedia', + 'CancelFavoritePublicMedia', + 'GetPublicMediaInfo', + 'SearchPublicMediaInfo', + ], + ], + 'GetStorageList', + 'SearchEditingProject', + 'SubmitDynamicChartJob', + 'StopRtcRobotInstance', + 'StartRtcRobotInstance', + 'UpdateRtcRobotInstance', + 'DescribeRtcRobotInstance', + 'SetNotifyConfig', + 'DescribeNotifyConfig', + 'CancelIProductionJob', + 'SubmitSceneMediaSelectionJob', + 'SubmitSceneBatchEditingJob', + 'SubmitSceneTimelineOrganizationJob', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AIAgentConfig' => [ + 'description' => '智能体模版参数。', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'description' => '问候语，修改后下次入会生效。默认无。', + 'type' => 'string', + 'example' => '你好', + ], + 'WakeUpQuery' => [ + 'description' => '用户在通话启动前的指令，智能体在通话启动后立即响应这一句话。', + 'type' => 'string', + 'example' => '今天天气怎么样？'."\n", + ], + 'MaxIdleTime' => [ + 'description' => '和智能体无互动的最大等待时间，超时智能体下线。单位：秒。默认：600 秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'UserOnlineTimeout' => [ + 'description' => '用户未入会，智能体超时关闭任务的时间。单位：秒。默认值：60 秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'UserOfflineTimeout' => [ + 'description' => '用户退会后，智能体超时关闭任务的时间。单位：秒。默认值：5 秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'EnablePushToTalk' => [ + 'description' => '是否开启对讲机模式。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GracefulShutdown' => [ + 'description' => '是否优雅下线。默认 false。'."\n" + ."\n" + .'优雅下线：当智能体被停止的时候，播报完当前说的话再停止，最多播报 10 秒。', + 'type' => 'boolean', + 'example' => 'false'."\n", + ], + 'Volume' => [ + 'description' => '智能体说话的音量。'."\n" + ."\n" + .'- 若不填：默认使用阿里云推荐的自适应音量模式'."\n" + ."\n" + .'- 若填写：填写范围为 0~400，输出音量=工作流中的语音输出音量 * volume/100。示例：'."\n" + .'1. 若 volume=0，则代表输出音量为 0。'."\n" + ."\n" + .'2. 若 volume=100，音量为原声音量。'."\n" + ."\n" + .'3. 若 volume=200，音量等于原声音量的 2 倍。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'WorkflowOverrideParams' => [ + 'description' => '工作流覆盖参数，默认无。', + 'type' => 'string', + 'example' => '{}', + ], + 'AvatarUrl' => [ + 'description' => '语音通话的智能体头像的头像链接。默认无。', + 'type' => 'string', + 'example' => 'http://example.com/a.jpg'."\n", + ], + 'AvatarUrlType' => [ + 'description' => '智能体头像链接类型，默认无。', + 'type' => 'string', + 'example' => 'USER', + ], + 'EnableIntelligentSegment' => [ + 'description' => '智能断句开关，开启智能断句后，用户说话的发生断句会智能合并成一句。默认为 true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AsrConfig' => [ + 'description' => '语音识别配置', + 'type' => 'object', + 'properties' => [ + 'AsrLanguageId' => [ + 'description' => 'asr 语种 Id。 可选：'."\n" + ."\n" + .'- zh_mandarin 中文'."\n" + ."\n" + .'- en 英文'."\n" + ."\n" + .'- zh_en 中英混'."\n" + ."\n" + .'- es 西班牙语'."\n" + ."\n" + .'- jp 日语', + 'type' => 'string', + 'example' => 'zh_mandarin', + ], + 'AsrMaxSilence' => [ + 'description' => '语音断句检测阈值，静音时长超过该阈值会被认为断句，参数范围 200ms～1200ms，默认值 400ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'AsrHotWords' => [ + 'description' => 'Asr 热词列表。热词列表最大支持 128 个词。', + 'type' => 'array', + 'items' => [ + 'description' => '热词字符串。字符长度: [1,10]个字符', + 'type' => 'string', + 'example' => '检查', + ], + ], + 'VadLevel' => [ + 'description' => '打断阈值参数。取值范围：[0,11], 默认值：11。'."\n" + ."\n" + .'- 0表示关闭 vad 功能。'."\n" + .'- 1-10设置数字越高表示越难打断。'."\n" + .'- 11与之前显著不同，前处理对话音损伤更低，抗干扰更强。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'CustomParams' => [ + 'description' => 'asr自研接入透传参数。', + 'type' => 'string', + 'example' => 'mode=fast&sample=16000&format=wav', + ], + 'VadDuration' => [ + 'description' => '语音活动检测的最短持续时间阈值，用于控制打断的灵敏度。0表示关闭此功能。有效范围：200到2000毫秒。常用[200,500] 对应1-4个字。默认为空，不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + ], + ], + 'TtsConfig' => [ + 'description' => '语音合成配置。', + 'type' => 'object', + 'properties' => [ + 'VoiceId' => [ + 'description' => '音色 ID，修改后下句话生效。不填写则使用智能体模版配置的音色 ID。仅针对预置 TTS 生效。输入长度不超过 64。可选值参考：[智能语音效果示例](~~449563~~)。', + 'type' => 'string', + 'example' => 'longcheng_v2'."\n" + ."\n", + ], + 'VoiceIdList' => [ + 'description' => '可选音色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音色', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + 'PronunciationRules' => [ + 'description' => 'TTS发音规则，数组长度不超过20个，规则按顺序执行。', + 'type' => 'array', + 'items' => [ + 'description' => 'TTS发音规则。', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'description' => '需要替换的词，长度小于10，必须是中文字符，不支持空格。', + 'type' => 'string', + 'example' => '一一零', + ], + 'Pronunciation' => [ + 'description' => '目标的发音， 长度小于10，必须是中文字符，不支持空格。', + 'type' => 'string', + 'example' => '幺幺零', + ], + 'Type' => [ + 'description' => '具体发音规则类型。'."\n" + .'可选：'."\n" + ."\n" + .'- replacement 直接将Word替换为Pronunciation的规则。', + 'type' => 'string', + 'example' => 'replacement', + ], + ], + ], + ], + 'ModelId' => [ + 'description' => '当前仅支持minimax，可选值：'."\n" + .'speech-01-turbo / speech-02-turbo', + 'type' => 'string', + 'example' => 'speech-01-turbo', + ], + 'LanguageId' => [ + 'description' => '当前仅支持minimax，默认为空。增强对指定的小语种和方言的识别能力，设置后可以提升在指定小语种/方言场景下的语音表现。如果不明确小语种类型，则可以选择"auto"，模型将自主判断小语种类型。支持以下取值：'."\n" + .'<details>'."\n" + .'<summary>支持语种</summary>'."\n" + ."\n" + .'- Chinese：中文'."\n" + .'- Chinese,Yue：粤语'."\n" + .'- English：英语'."\n" + .'- Arabic：阿拉伯语'."\n" + .'- Russian：俄语'."\n" + .'- Spanish：西班牙语'."\n" + .'- French：法语'."\n" + .'- Portuguese：葡萄牙语'."\n" + .'- German：德语'."\n" + .'- Turkish：土耳其语'."\n" + .'- Dutch：荷兰语'."\n" + .'- Ukrainian：乌克兰语'."\n" + .'- Vietnamese：越南语'."\n" + .'- Indonesian：印度尼西亚语'."\n" + .'- Japanese：日语'."\n" + .'- Italian：意大利语'."\n" + .'- Korean：韩语'."\n" + .'- Thai：泰语'."\n" + .'- Polish：波兰语'."\n" + .'- Romanian：罗马尼亚语'."\n" + .'- Greek：希腊语'."\n" + .'- Czech：捷克语'."\n" + .'- Finnish：芬兰语'."\n" + .'- Hindi：印地语'."\n" + .'- auto：自动检测'."\n" + .'</details>', + 'type' => 'string', + 'example' => 'Chinese', + ], + 'Emotion' => [ + 'description' => '当前仅支持minimax，minimax当前支持7种情绪：'."\n" + ."\n" + .'- happy：高兴'."\n" + .'- sad：悲伤'."\n" + .'- angry：愤怒'."\n" + .'- fearful：害怕'."\n" + .'- disgusted：厌恶'."\n" + .'- surprised：惊讶'."\n" + .'- calm：中性', + 'type' => 'string', + 'example' => 'happy', + ], + 'SpeechRate' => [ + 'description' => '支持全平台。'."\n" + .'cosyvoice默认1.0，取值范围：0.5-2.0。'."\n" + .'minimax默认1.0， 取值范围: 0.5-2.0。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + ], + ], + 'LlmConfig' => [ + 'description' => '大语言模型配置', + 'type' => 'object', + 'properties' => [ + 'LlmHistory' => [ + 'description' => 'llm/mllm历史对话上下文', + 'type' => 'array', + 'items' => [ + 'description' => '单个对话', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '表示对话参与者的角色。可选值包括：'."\n" + ."\n" + .'- user: 用户'."\n" + ."\n" + .'- assistant: 助手'."\n" + ."\n\n" + ."\n" + .'- system: 系统'."\n" + ."\n\n" + .'- function: 函数'."\n" + ."\n\n" + ."\n" + .'- plugin: 插件'."\n" + ."\n\n" + ."\n" + .'- tool: 工具', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'description' => '存储实际的对话内容文本，记录了该角色在对话中的具体表达或回应。', + 'type' => 'string', + 'example' => '你好', + ], + ], + ], + ], + 'LlmHistoryLimit' => [ + 'description' => 'llm/mllm 历史对话上下文最大保留轮次，默认 10 次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LlmSystemPrompt' => [ + 'description' => '启动通话后 llm 的系统提示词。', + 'type' => 'string', + 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n", + ], + 'BailianAppParams' => [ + 'description' => '阿里云百炼应用中心参数，类型为JSON字符串。参数格式参考：'."\n" + .'[阿里云百炼应用中心参数](~~2858132~~)', + 'type' => 'string', + 'example' => '"{\\"biz_params\\":{\\"user_defined_params\\":{\\"your_plugin_id\\":{\\"article_index\\":2}}},\\"memory_id\\":\\"your_memory_id\\",\\"image_list\\":[\\"https://your_image_url\\"],\\"rag_options\\":{\\"pipeline_ids\\":[\\"your_id\\"],\\"file_ids\\":[\\"文档ID1\\",\\"文档ID2\\"],\\"metadata_filter\\":{\\"name\\":\\"张三\\"},\\"structured_filter\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"},\\"tags\\":[\\"标签1\\",\\"标签2\\"]}}"', + ], + 'OpenAIExtraQuery' => [ + 'description' => '额外的 OpenAI协议LLM的查询参数, 参数必须使用 key=value 格式,多个参数用 & 连接,所有值必须为字符串类型。', + 'type' => 'string', + 'example' => 'api-version=2024-02-01&api-key=sk-xxx', + ], + 'LlmCompleteReply' => [ + 'description' => '开启后，llm回复完整结果之后，智能体会向客户端发送完整llm结果。此开关不影响字幕的流式生成。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FunctionMap' => [ + 'description' => '功能映射列表，用于将智能体能力与LLM函数对应。当前只支持和用户自定义openai协议llm的函数调用。', + 'type' => 'array', + 'items' => [ + 'description' => '单个对应规则。', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => '阿里智能体系统提供的内置功能名称。当前只支持hangup(挂断)。', + 'type' => 'string', + 'example' => 'hangup', + ], + 'MatchFunction' => [ + 'description' => '要与该功能对应的LLM函数名称，由客户自定义，用于在LLM中调用对应功能。用户自定义llm协议参考：[LLM标准接口](~~2839094~~)', + 'type' => 'string', + 'example' => 'hangup', + ], + ], + ], + ], + 'OutputMinLength' => [ + 'description' => '文本输出最小长度（字符数），小于该长度的文本会被缓存等待拼接，范围[0, 100]，0或空表示不限制，默认空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'OutputMaxDelay' => [ + 'description' => '文本输出最大延迟时间（毫秒），超过该时间强制输出已缓存文本，。范围[1000,10000]，0或空表示不限制，默认空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'HistorySyncWithTTS' => [ + 'description' => '大模型消息历史，是否和tts播放内容保持一致。默认false。开启后，保存的大模型消息和tts播放内容保持一致。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'AvatarConfig' => [ + 'description' => '数字人配置，只有当工作流中包含数字人节点才会生效。', + 'type' => 'object', + 'properties' => [ + 'AvatarId' => [ + 'description' => '数字人的模型id。', + 'type' => 'string', + 'example' => '5257', + ], + ], + ], + 'InterruptConfig' => [ + 'description' => '语音打断策略配置。', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => [ + 'description' => '是否支持语音打断，默认 true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InterruptWords' => [ + 'description' => '触发对话中断的特定词汇或短语列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'string', + 'example' => '打断一下', + ], + ], + 'NoInterruptMode' => [ + 'description' => '<No Interrupting> 模式下的 ASR 处理策略'."\n" + ."\n" + .'- cache: 缓存ASR文本，当前轮次结束后，被缓存的asr文本会在下一个轮次一起被处理。'."\n" + ."\n" + .'- discard: 直接丢弃ASR文本。'."\n" + ."\n" + .'默认处理是缓存ASR文本', + 'type' => 'string', + 'example' => 'cache', + ], + ], + ], + 'VoiceprintConfig' => [ + 'description' => '声纹配置', + 'type' => 'object', + 'properties' => [ + 'UseVoiceprint' => [ + 'description' => '是否使用声纹识别的开关。默认值：false。开启声纹时需要传入合法的声纹Id', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VoiceprintId' => [ + 'description' => '声纹识别的唯一身份 ID。默认值：不填。传入的声纹id必须已经通过声纹注册接口注册，接口文档参考：[注册人声声纹](~~2964738~~)', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + 'RegistrationMode' => [ + 'type' => 'string', + ], + ], + ], + 'TurnDetectionConfig' => [ + 'description' => '对话轮次检测配置', + 'type' => 'object', + 'properties' => [ + 'TurnEndWords' => [ + 'description' => '用于判断用户轮次结束的关键词列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用于判断用户轮次结束的关键词。', + 'type' => 'string', + 'example' => '我说完了', + ], + ], + 'Mode' => [ + 'description' => '轮次检测的模式。'."\n" + ."\n" + .'- Normal（默认值）：普通模式，不使用AI判断语义；'."\n" + ."\n" + .'- Semantic：用AI根据上下文语义，判断是否说完话了。', + 'type' => 'string', + 'example' => 'Semantic', + ], + 'SemanticWaitDuration' => [ + 'description' => 'AI模式下的停顿判定时间，单位:毫秒，默认值-1。'."\n" + ."\n" + .'- -1: AI自动判断合适的等待时间'."\n" + ."\n" + .'- 0-10000: 自定义等待时间，建议设置在0-1500ms'."\n" + ."\n" + .'> 普通模式下此项无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'Eagerness' => [ + 'description' => '仅在 Semantic 模式下生效。控制 AI 检测到停顿后，启动回应的快慢程度：'."\n" + .'- "Low"：耐心等待，最长等待时间6秒，减少被打断风险。'."\n" + .'- "Medium"：平衡等待（最长等待时间4秒），适用大多数场景。'."\n" + .'- "High"：快速响应（最长等待时间2秒），提升速度但可能增加误切风险。'."\n" + ."\n" + .'字段默认空。', + 'type' => 'string', + 'example' => 'High', + ], + ], + ], + 'ExperimentalConfig' => [ + 'description' => '实验功能参数，有需求请联系答疑。', + 'type' => 'string', + 'example' => '""', + ], + 'VcrConfig' => [ + 'description' => '视频识别内容功能配置，支持向客户端回调算法在视频中识别的内容。', + 'type' => 'object', + 'properties' => [ + 'StillFrameMotion' => [ + 'description' => '画面静止帧检测配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启静帧检查，默认false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CallbackDelay' => [ + 'description' => '静止帧检查延迟通知延时，设置后会在静止帧持续一段时间后，再触发通知。单位毫秒。默认为空，通话会使用控制台配置。取值范围[200,5000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + ], + ], + 'InvalidFrameMotion' => [ + 'description' => '画面无效帧检查参数配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启无效帧检查。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CallbackDelay' => [ + 'description' => '画面无效帧检查延迟通知延时，设置后会在静止帧持续一段时间后，再触发通知。单位毫秒。默认为空，通话会使用控制台配置。取值范围[200,5000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + ], + ], + 'PeopleCount' => [ + 'description' => '人数统计功能配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '开关，默认false。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Equipment' => [ + 'description' => '设备识别配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启禁用设备检查，默认false', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'HeadMotion' => [ + 'description' => '头部动作识别配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启头部动作识别检查。默认false', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'LookAway' => [ + 'description' => '视线偏移识别配置。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启视线偏移配置。默认false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'AmbientSoundConfig' => [ + 'description' => '通话环境音配置。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '通话环境音ID，可以在控制台上智能体配置的高级配置中获取。', + 'type' => 'string', + 'example' => 'f67901c595834************', + ], + 'Volume' => [ + 'description' => '通话背景音的音量，可选值：[0, 100]，0表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + 'AutoSpeechConfig' => [ + 'description' => '智能体自动说话配置模块，包括 LLM 等待提示和用户长时间静默问询。', + 'type' => 'object', + 'properties' => [ + 'UserIdle' => [ + 'description' => '用户长时间静默时的问询播报配置。', + 'type' => 'object', + 'properties' => [ + 'WaitTime' => [ + 'description' => '静默时长阈值，单位毫秒，必填。超过此时长触发问询。范围 5000–600000ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'MaxRepeats' => [ + 'description' => '最大问询次数，范围 0–10，必填。超过后不再触发，直接关闭通话。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Messages' => [ + 'description' => '问询提示语集合，最大 10 条，每条长度 ≤ 100 字符，概率总和为100%。', + 'type' => 'array', + 'items' => [ + 'description' => '问询词结构', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '问询提示语文本，最长 100 字符。', + 'type' => 'string', + 'example' => '您还在吗？', + ], + 'Probability' => [ + 'description' => '提示语的选择概率，范围 0–1，对应0%-100%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + 'LlmPending' => [ + 'description' => 'LLM 响应延迟时的播报配置。', + 'type' => 'object', + 'properties' => [ + 'WaitTime' => [ + 'description' => '等待大模型回复时长阈值。超过此时长，触发播报提示。必填，单位毫秒，范围 500–10000ms。请用户根据大模型的实际使用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'Messages' => [ + 'description' => '问询提示语集合，最大 10 条，每条长度 ≤ 100 字符，概率总和为100%。', + 'type' => 'array', + 'items' => [ + 'description' => '问询词结构', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '问询提示语文本，最长 100 字符。', + 'type' => 'string', + 'example' => '稍等一下', + ], + 'Probability' => [ + 'description' => '提示语的选择概率，范围 0–1，对应0%-100%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'BackChannelingConfigs' => [ + 'description' => '附和语功能配置模块。开启后，系统会在特定触发时机随机播报简短的附和语。', + 'type' => 'array', + 'items' => [ + 'description' => '单个附和语配置', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否启用附和功能。必填，取值 true/false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerStage' => [ + 'description' => '附和触发的时机。可选值：'."\n" + ."\n" + .'- pause_detected（检测到说话短暂停顿）', + 'type' => 'string', + 'example' => 'pause_detected', + ], + 'Probability' => [ + 'description' => '功能触发概率。范围 0.0–1.0。必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + 'Words' => [ + 'description' => '附和短语集合。最大 10 条，每条短语长度 ≤ 20 字符，概率总和为1.0。', + 'type' => 'array', + 'items' => [ + 'description' => '附和短语配置', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '短语文本，长度 ≤ 20 字符，支持多语言。必填。', + 'type' => 'string', + 'example' => '嗯嗯', + ], + 'Probability' => [ + 'description' => '本短语的触发概率，范围 0.0–1.0，必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + ], + ], + ], + 'BackChannelingConfig' => [ + 'description' => '><notice>已废弃，请使用BackChannelingConfigs></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '单个附和语配置', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否启用附和功能。必填，取值 true/false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerStage' => [ + 'description' => '附和触发的时机。可选值：'."\n" + ."\n" + .'- pause_detected（检测到说话短暂停顿）', + 'type' => 'string', + 'example' => 'pause_detected', + ], + 'Probability' => [ + 'description' => '功能触发概率。范围 0.0–1.0。必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + 'Words' => [ + 'description' => '附和短语集合。最大 10 条，每条短语长度 ≤ 20 字符，概率总和为1.0。', + 'type' => 'array', + 'items' => [ + 'description' => '附和短语配置', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '短语文本，长度 ≤ 20 字符，支持多语言。必填。', + 'type' => 'string', + 'example' => '嗯嗯', + ], + 'Probability' => [ + 'description' => '本短语的触发概率，范围 0.0–1.0，必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + ], + ], + 'deprecated' => true, + ], + ], + ], + 'AIAgentOutboundCallConfig' => [ + 'description' => '智能体模版参数', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'description' => '问候语，修改后下次入会生效。默认无。', + 'type' => 'string', + 'example' => '你好', + ], + 'EnableIntelligentSegment' => [ + 'description' => '智能断句开关，开启智能断句后，用户说话的发生断句会智能合并成一句。默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AsrConfig' => [ + 'description' => '语音识别配置', + 'type' => 'object', + 'properties' => [ + 'AsrMaxSilence' => [ + 'description' => '语音断句检测阈值，静音时长超过该阈值会被认为断句，参数范围 200ms～1200ms，默认值 400ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'AsrLanguageId' => [ + 'description' => 'asr 语种 Id。 可选：'."\n" + ."\n" + .'- zh_mandarin 中文'."\n" + ."\n\n" + ."\n" + .'- en 英文'."\n" + ."\n\n" + .'- zh_en 中英混'."\n" + ."\n\n" + ."\n" + .'- es 西班牙语'."\n" + ."\n\n" + .'- jp 日语', + 'type' => 'string', + 'example' => 'zh_mandarin', + ], + 'AsrHotWords' => [ + 'description' => 'Asr 热词列表。热词列表最大支持 128 个词。', + 'type' => 'array', + 'items' => [ + 'description' => '热词字符串。字符长度: [1,10]个字符', + 'type' => 'string', + 'example' => '检查'."\n", + ], + ], + 'VadLevel' => [ + 'description' => '打断阈值参数。取值范围：[0,11], 默认值：11。'."\n" + ."\n" + .'- 0表示关闭 vad 功能。'."\n" + .'- 1-10设置数字越高表示越难打断。'."\n" + .'- 11与之前显著不同，前处理对话音损伤更低，抗干扰更强。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'CustomParams' => [ + 'description' => 'asr自研接入透传参数。', + 'type' => 'string', + 'example' => 'mode=fast&sample=16000&format=wav'."\n", + ], + 'VadDuration' => [ + 'description' => '语音活动检测的最短持续时间阈值，用于控制打断的灵敏度。0表示关闭此功能。有效范围：200到2000毫秒。常用[200,500] 对应1-4个字。默认为空，不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + ], + ], + 'LlmConfig' => [ + 'description' => '大语言模型配置', + 'type' => 'object', + 'properties' => [ + 'LlmHistoryLimit' => [ + 'description' => 'llm/mllm 历史对话上下文最大保留轮次，默认 10 次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LlmHistory' => [ + 'description' => 'llm/mllm历史对话上下文', + 'type' => 'array', + 'items' => [ + 'description' => '单个对话', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '表示对话参与者的角色。可选值包括：'."\n" + ."\n" + .'- user: 用户'."\n" + ."\n" + .'- assistant: 助手'."\n" + ."\n" + .'- system: 系统'."\n" + ."\n" + .'- function: 函数'."\n" + ."\n" + .'- plugin: 插件'."\n" + ."\n" + .'- tool: 工具', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'description' => '存储实际的对话内容文本，记录了该角色在对话中的具体表达或回应。', + 'type' => 'string', + 'example' => '你好', + ], + ], + ], + ], + 'LlmSystemPrompt' => [ + 'description' => '启动通话后llm的系统提示词。', + 'type' => 'string', + 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n", + ], + 'BailianAppParams' => [ + 'description' => '阿里云百炼应用中心参数。参数格式参考：[阿里云百炼应用中心参数](~~2858132~~)', + 'type' => 'string', + 'example' => '"{\\"biz_params\\":{\\"user_defined_params\\":{\\"your_plugin_id\\":{\\"article_index\\":2}}},\\"memory_id\\":\\"your_memory_id\\",\\"image_list\\":[\\"https://your_image_url\\"],\\"rag_options\\":{\\"pipeline_ids\\":[\\"your_id\\"],\\"file_ids\\":[\\"文档ID1\\",\\"文档ID2\\"],\\"metadata_filter\\":{\\"name\\":\\"张三\\"},\\"structured_filter\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"},\\"tags\\":[\\"标签1\\",\\"标签2\\"]}}"'."\n", + ], + 'OpenAIExtraQuery' => [ + 'description' => '额外的 OpenAI协议LLM的查询参数, 参数必须使用 key=value 格式,多个参数用 & 连接,所有值必须为字符串类型。', + 'type' => 'string', + 'example' => 'api-version=2024-02-01&api-key=sk-xxx', + ], + 'LlmCompleteReply' => [ + 'description' => '开启后，llm生成结果之后，会向客户端发送完整llm结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FunctionMap' => [ + 'description' => '功能映射列表，用于将智能体能力与LLM函数对应。当前只支持和用户自定义openai协议llm的函数调用。', + 'type' => 'array', + 'items' => [ + 'description' => '单个对应规则。', + 'type' => 'object', + 'properties' => [ + 'Function' => [ + 'description' => '阿里智能体系统提供的内置功能名称。当前只支持hangup(挂断)。', + 'type' => 'string', + 'example' => 'hangup', + ], + 'MatchFunction' => [ + 'description' => '要与该功能对应的LLM函数名称，由客户自定义，用于在LLM中调用对应功能。用户自定义llm协议参考：[LLM标准接口](~~2839094~~)', + 'type' => 'string', + 'example' => 'hangup', + ], + ], + ], + ], + 'OutputMinLength' => [ + 'description' => '文本输出最小长度(字符数)，小于该长度的文本会被缓存等待拼接，范围[0, 100]，0或空表示不限制，默认空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'OutputMaxDelay' => [ + 'description' => '文本输出最大延迟时间(毫秒)，超过该时间强制输出已缓存文本，。范围[1000,10000]，0或空表示不限制，默认空。', + 'type' => 'string', + 'example' => '2000', + ], + 'HistorySyncWithTTS' => [ + 'description' => '大模型消息历史，是否和tts播放内容保持一致。默认false。开启后，保存的大模型消息和tts播放内容保持一致。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'TtsConfig' => [ + 'description' => '语音合成配置', + 'type' => 'object', + 'properties' => [ + 'VoiceId' => [ + 'description' => '音色ID，修改后下句话生效。不填写则使用智能体模版配置的音色ID。仅针对预置TTS生效。输入长度不超过64。可选值参考：[智能语音效果示例](~~449563~~)。', + 'type' => 'string', + 'example' => 'longcheng_v2', + ], + 'VoiceIdList' => [ + 'description' => '可选音色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音色。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + 'PronunciationRules' => [ + 'description' => 'Tts发音规则，数组长度不超过20个，规则按顺序执行。', + 'type' => 'array', + 'items' => [ + 'description' => 'Tts发音规则。', + 'type' => 'object', + 'properties' => [ + 'Word' => [ + 'description' => '需要替换的词，长度小于10，必须是中文字符，不支持空格。', + 'type' => 'string', + 'example' => '大栅栏'."\n", + ], + 'Pronunciation' => [ + 'description' => '目标的发音， 长度小于10，必须是中文字符，不支持空格。', + 'type' => 'string', + 'example' => '大石烂儿'."\n", + ], + 'Type' => [ + 'description' => '具体发音规则类型。 可选：'."\n" + ."\n" + .'- replacement。直接将Word替换为Pronunciation的规则。', + 'type' => 'string', + 'example' => 'replacement'."\n", + ], + ], + ], + ], + 'ModelId' => [ + 'description' => '当前仅支持minimax，可选值： speech-01-turbo / speech-02-turbo', + 'type' => 'string', + 'example' => 'speech-01-turbo', + ], + 'LanguageId' => [ + 'description' => '当前仅支持minimax，默认为空。增强对指定的小语种和方言的识别能力，设置后可以提升在指定小语种/方言场景下的语音表现。如果不明确小语种类型，则可以选择"auto"，模型将自主判断小语种类型。支持以下取值：'."\n" + .'<details>'."\n" + .'<summary>支持语种</summary>'."\n" + ."\n" + .'- Chinese：中文'."\n" + .'- Chinese,Yue：粤语'."\n" + .'- English：英语'."\n" + .'- Arabic：阿拉伯语'."\n" + .'- Russian：俄语'."\n" + .'- Spanish：西班牙语'."\n" + .'- French：法语'."\n" + .'- Portuguese：葡萄牙语'."\n" + .'- German：德语'."\n" + .'- Turkish：土耳其语'."\n" + .'- Dutch：荷兰语'."\n" + .'- Ukrainian：乌克兰语'."\n" + .'- Vietnamese：越南语'."\n" + .'- Indonesian：印度尼西亚语'."\n" + .'- Japanese：日语'."\n" + .'- Italian：意大利语'."\n" + .'- Korean：韩语'."\n" + .'- Thai：泰语'."\n" + .'- Polish：波兰语'."\n" + .'- Romanian：罗马尼亚语'."\n" + .'- Greek：希腊语'."\n" + .'- Czech：捷克语'."\n" + .'- Finnish：芬兰语'."\n" + .'- Hindi：印地语'."\n" + .'- auto：自动检测'."\n" + .'</details>', + 'type' => 'string', + 'example' => 'Chinese', + ], + 'Emotion' => [ + 'description' => '当前仅支持minimax，minimax当前支持7种情绪：'."\n" + ."\n" + .'- happy：高兴'."\n" + .'- sad：悲伤'."\n" + .'- angry：愤怒'."\n" + .'- fearful：害怕'."\n" + .'- disgusted：厌恶'."\n" + .'- surprised：惊讶'."\n" + .'- calm：中性', + 'type' => 'string', + 'example' => 'happy', + ], + 'SpeechRate' => [ + 'description' => '支持全平台。 cosyvoice默认1.0，取值范围：0.5-2.0。 minimax默认1.0， 取值范围: 0.5-2.0。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + ], + ], + 'InterruptConfig' => [ + 'description' => '语音打断策略配置。', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => [ + 'description' => '是否支持语音打断，默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InterruptWords' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'array', + 'items' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'string', + 'example' => '打断一下'."\n", + ], + ], + 'Eagerness' => [ + 'type' => 'string', + 'deprecated' => true, + ], + 'NoInterruptMode' => [ + 'description' => '<No Interrupting> 模式下的 ASR 处理策略'."\n" + ."\n" + .'- cache: 缓存ASR文本，当前轮次结束后，被缓存的asr文本会在下一个轮次一起被处理。'."\n" + ."\n" + .'- discard:'."\n" + .' 直接丢弃ASR文本.'."\n" + ."\n" + .'默认处理是缓存ASR文本', + 'type' => 'string', + 'example' => 'cache', + ], + ], + ], + 'TurnDetectionConfig' => [ + 'description' => '对话轮次检测配置', + 'type' => 'object', + 'properties' => [ + 'TurnEndWords' => [ + 'description' => '用于判断用户轮次结束的关键词列表', + 'type' => 'array', + 'items' => [ + 'description' => '用于判断用户轮次结束的关键词', + 'type' => 'string', + 'example' => '我说完了', + ], + ], + 'Mode' => [ + 'description' => '轮次检测的模式。'."\n" + ."\n" + .'- Normal：普通模式，不使用AI判断语义；'."\n" + ."\n" + .'- Semantic：用AI根据上下文语义，判断是否说完话了。'."\n" + ."\n" + .'默认值Normal。', + 'type' => 'string', + 'example' => 'Semantic', + ], + 'SemanticWaitDuration' => [ + 'description' => 'AI模式下的停顿判定时间，单位：毫秒，默认值-1。'."\n" + ."\n" + .'- -1: AI自动判断合适的等待时间'."\n" + ."\n" + .'- 0-10000: 自定义等待时间，建议设置在0-1500ms'."\n" + ."\n" + .'注意:普通模式下此项无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'Eagerness' => [ + 'type' => 'string', + ], + ], + ], + 'GreetingDelay' => [ + 'description' => '欢迎语延迟时间，单位毫秒，默认0毫秒，范围：0-5000ms', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AmbientSoundConfig' => [ + 'description' => '通话环境音配置。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '通话环境音ID，可以在控制台上智能体配置的高级配置中获取。', + 'type' => 'string', + 'example' => 'f67901c595834************'."\n", + ], + 'Volume' => [ + 'description' => '通话背景音的音量，可选值：[0, 100]，0表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50'."\n", + ], + ], + ], + 'ExperimentalConfig' => [ + 'description' => '实验功能参数，有需求请联系答疑。', + 'type' => 'string', + 'example' => '""', + ], + 'AutoSpeechConfig' => [ + 'description' => '智能体自动说话配置模块，包括 LLM 等待提示和用户长时间静默问询。', + 'type' => 'object', + 'properties' => [ + 'UserIdle' => [ + 'description' => '用户长时间静默时的问询播报配置。', + 'type' => 'object', + 'properties' => [ + 'WaitTime' => [ + 'description' => '静默时长阈值，单位毫秒，必填。超过此时长触发问询。范围 5000–600000ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'MaxRepeats' => [ + 'description' => '最大问询次数，范围 0–10，必填。超过后不再触发，直接关闭通话。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Messages' => [ + 'description' => '问询提示语集合，最大 10 条，每条长度 ≤ 100 字符，概率总和为100%。', + 'type' => 'array', + 'items' => [ + 'description' => '问询词结构', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '问询提示语文本，最长 100 字符。', + 'type' => 'string', + 'example' => '您还在吗？', + ], + 'Probability' => [ + 'description' => '提示语的选择概率，取值范围为 0–1，对应 0%–100%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + 'LlmPending' => [ + 'description' => 'LLM 响应延迟时的播报配置。', + 'type' => 'object', + 'properties' => [ + 'WaitTime' => [ + 'description' => '等待大模型回复时长阈值。超过此时长，触发播报提示。必填，单位毫秒，范围 500–10000ms。请用户根据大模型的实际使用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'Messages' => [ + 'description' => '问询提示语集合，最大 10 条，每条长度 ≤ 100 字符，概率总和为100%。', + 'type' => 'array', + 'items' => [ + 'description' => '问询词结构', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '问询提示语文本，最长 100 字符。', + 'type' => 'string', + 'example' => '稍等一下', + ], + 'Probability' => [ + 'description' => '提示语的选择概率，取值范围为 0–1，对应 0%–100%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'MaxIdleTime' => [ + 'description' => '和智能体无互动的最大等待时间，超时智能体下线。单位：秒。默认：600 秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'BackChannelingConfig' => [ + 'description' => '><notice>已废弃，请使用BackChannelingConfigs></notice>', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'type' => 'boolean', + ], + 'TriggerStage' => [ + 'type' => 'string', + ], + 'Probability' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'Words' => [ + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'type' => 'string', + ], + 'Probability' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + 'deprecated' => true, + ], + 'BackChannelingConfigs' => [ + 'description' => '附和语功能配置模块。开启后，系统会在特定触发时机随机播报简短的附和语。', + 'type' => 'array', + 'items' => [ + 'description' => '单个附和语配置', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否启用附和功能。必填，取值 true/false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerStage' => [ + 'description' => '附和触发的时机。可选值：'."\n" + ."\n" + .'- pause_detected（检测到说话短暂停顿）', + 'type' => 'string', + 'example' => 'pause_detected', + ], + 'Probability' => [ + 'description' => '功能触发概率。范围 0.0–1.0。必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + 'Words' => [ + 'description' => '附和短语集合。最大 10 条，每条短语长度 ≤ 20 字符，概率总和为1.0。', + 'type' => 'array', + 'items' => [ + 'description' => '附和短语配置', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '短语文本，长度 ≤ 20 字符，支持多语言。必填。', + 'type' => 'string', + 'example' => '嗯嗯', + ], + 'Probability' => [ + 'description' => '本短语的触发概率，范围 0.0–1.0，必填。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AIAgentRuntimeConfig' => [ + 'title' => 'A short description of struct', + 'description' => 'ims AIAgent运行时参数', + 'type' => 'object', + 'properties' => [ + 'VoiceChat' => [ + 'title' => '语音通话运行时参数', + 'description' => '语音通话运行时参数', + 'type' => 'object', + 'properties' => [ + 'AuthToken' => [ + 'title' => '智能体的入会凭证，需要用户自己通过的AppKey生成', + 'description' => '智能体的入会凭证，需要用户自己通过AppKey生成，必填。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'AgentUserId' => [ + 'title' => '频道内智能体名称', + 'description' => 'ARTC频道内智能体名称，必填。', + 'type' => 'string', + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + 'ChannelId' => [ + 'title' => '语音通话频道', + 'description' => 'ARTC频道，必填。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208', + ], + ], + 'deprecated' => true, + ], + 'AuthToken' => [ + 'description' => '智能体的入会凭证，需要用户自己通过AppKey生成。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'AgentUserId' => [ + 'description' => 'ARTC频道内智能体名称。', + 'type' => 'string', + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + 'VisionChat' => [ + 'description' => '视觉智能体运行时参数', + 'type' => 'object', + 'properties' => [ + 'AuthToken' => [ + 'description' => '智能体的入会凭证，需要用户自己通过AppKey生成，必填。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'AgentUserId' => [ + 'description' => 'ARTC频道内智能体名称，必填。', + 'type' => 'string', + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + 'ChannelId' => [ + 'description' => 'ARTC频道，必填。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208', + ], + ], + 'deprecated' => true, + ], + 'ChannelId' => [ + 'description' => 'ARTC频道。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208'."\n", + ], + 'AvatarChat3D' => [ + 'title' => '3d数字人运行时参数', + 'description' => '3D数字人运行时参数', + 'type' => 'object', + 'properties' => [ + 'AuthToken' => [ + 'title' => '智能体的入会凭证，需要用户自己通过的AppKey生成', + 'description' => '智能体的入会凭证，需要用户自己通过AppKey生成，必填。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'AgentUserId' => [ + 'title' => '频道内智能体名称', + 'description' => 'ARTC频道内智能体名称，必填。', + 'type' => 'string', + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + 'ChannelId' => [ + 'title' => '语音通话频道', + 'description' => 'ARTC频道，必填。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208', + ], + ], + 'deprecated' => true, + ], + ], + ], + 'AIAgentTemplateConfig' => [ + 'title' => 'A short description of struct', + 'description' => '智能体模版参数', + 'type' => 'object', + 'properties' => [ + 'VoiceChat' => [ + 'title' => '语音通话参数', + 'description' => '语音通话参数', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'title' => '问候语，修改后下次入会生效', + 'description' => '问候语，入会时生效。不填写则使用智能体模版配置的问候语。长度不超过128。', + 'type' => 'string', + 'example' => '早上好，我的朋友', + ], + 'LlmHistory' => [ + 'description' => 'llm/mllm历史对话上下文。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '表示对话参与者的角色。可选值包括：'."\n" + ."\n" + .'- user: 用户'."\n" + ."\n" + .'- assistant: 助手'."\n" + ."\n" + .'- system: 系统'."\n" + .'- function: 函数'."\n" + ."\n" + .'- plugin: 插件'."\n" + ."\n" + .'- tool: 工具', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'description' => '存储实际的对话内容文本，记录了该角色在对话中的具体表达或回应。', + 'type' => 'string', + 'example' => '你好', + ], + ], + ], + ], + 'WorkflowOverrideParams' => [ + 'description' => '工作流覆盖参数，默认无。', + 'type' => 'string', + 'example' => '{}', + ], + 'EnableIntelligentSegment' => [ + 'description' => '智能断句开关，开启智能断句后，用户说话的发生断句会智能合并成一句。默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AvatarUrlType' => [ + 'description' => '智能体头像链接类型，默认无。', + 'type' => 'string', + 'example' => 'USER', + ], + 'AvatarUrl' => [ + 'description' => '语音通话的智能体头像的头像链接。默认无。', + 'type' => 'string', + 'example' => 'http://example.com/a.jpg', + ], + 'VoiceIdList' => [ + 'description' => '可选音色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音色。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + 'CharBreak' => [ + 'type' => 'boolean', + ], + 'EnableVoiceInterrupt' => [ + 'title' => '是否支持语音打断', + 'description' => '是否支持语音打断，默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VoiceprintId' => [ + 'description' => '声纹识别的唯一身份ID。默认值：不填。', + 'type' => 'string', + 'example' => 'uniqueId', + ], + 'GracefulShutdown' => [ + 'title' => '是否优雅下线', + 'description' => '是否优雅下线，默认false。'."\n" + ."\n" + .'- 优雅下线：当智能体被停止的时候，播报完当前说的话再停止，最多播报10秒。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InterruptWords' => [ + 'description' => '触发对话中断的特定词汇或短语列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'string', + 'example' => '停止', + ], + ], + 'UserOnlineTimeout' => [ + 'description' => '用户未入会，智能体超时关闭任务的时间。单位：秒。默认值：60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'AsrLanguageId' => [ + 'description' => 'asr语种Id。'."\n" + .'可选：'."\n" + .'- zh_mandarin 中文'."\n" + .'- en 英文'."\n" + .'- zh_en 中英混'."\n" + .'- es 西班牙语'."\n" + .'- jp 日语', + 'type' => 'string', + 'example' => 'zh_mandarin', + ], + 'UserOfflineTimeout' => [ + 'description' => '用户退会后，智能体超时关闭任务的时间。单位：秒。默认值：5秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LlmSystemPrompt' => [ + 'description' => '启动通话后llm的系统提示词。', + 'type' => 'string', + 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。', + ], + 'BailianAppParams' => [ + 'description' => '阿里云百炼应用中心参数。参数格式参考：[阿里云百炼应用中心参数](~~2858132~~)', + 'type' => 'string', + 'example' => '{}', + ], + 'VadLevel' => [ + 'description' => '打断阈值参数。取值范围：[0,11], 默认值：11。'."\n" + ."\n" + .'- 0表示关闭 vad 功能。'."\n" + .'- 1-10设置数字越高表示越难打断。'."\n" + .'- 11与之前显著不同，前处理对话音损伤更低，抗干扰更强。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'LlmHistoryLimit' => [ + 'description' => 'llm/mllm历史对话上下文最大保留轮次，默认10次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AsrMaxSilence' => [ + 'description' => '语音断句检测阈值，静音时长超过该阈值会被认为断句，参数范围200ms～1200ms，默认值400ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'WakeUpQuery' => [ + 'description' => '用户在通话启动前的指令，用于智能体在通话启动后立即响应。', + 'type' => 'string', + 'example' => '今天天气怎么样？', + ], + 'Volume' => [ + 'title' => '音量', + 'description' => '智能体说话的音量。'."\n" + ."\n" + .'- 若不填：默认使用阿里云推荐的自适应音量模式'."\n" + ."\n" + .'- 若填写：填写范围为0~400，输出音量=工作流中的语音输出音量 * volume/100。示例：'."\n" + ."\n" + .'1. 若volume=0，则代表输出音量为0。'."\n" + .' '."\n" + .'2. 若volume=100，音量为原声音量。'."\n" + ."\n" + .'3. 若volume=200，音量等于原声音量的2倍。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'VoiceId' => [ + 'title' => '音色名称，修改后下句话生效', + 'description' => '音色ID，修改后下句话生效。不填写则使用智能体模版配置的音色ID。仅针对预置TTS生效。输入长度不超过64。可选值参考：[智能语音效果示例](~~449563~~)。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + 'UseVoiceprint' => [ + 'description' => '是否使用声纹识别的开关。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaxIdleTime' => [ + 'description' => '和智能体无互动的最大等待时间，超时智能体下线。单位：秒。默认：600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'AsrHotWords' => [ + 'description' => 'Asr热词列表。热词列表最大支持128个词。', + 'type' => 'array', + 'items' => [ + 'description' => '热词字符串。字符长度: [1,10]个字符', + 'type' => 'string', + 'example' => '检查', + ], + ], + 'EnablePushToTalk' => [ + 'description' => '是否开启对讲机模式。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'VisionChat' => [ + 'description' => '视觉智能体参数', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'description' => '问候语，入会时生效。不填写则使用智能体模版配置的问候语。长度不超过128。', + 'type' => 'string', + 'example' => '早上好，我的朋友！'."\n", + ], + 'LlmHistory' => [ + 'description' => 'llm/mllm历史对话上下文最大保留轮次，默认10次。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '表示对话参与者的角色。可选值包括：'."\n" + ."\n" + .'- user: 用户'."\n" + ."\n" + .'- assistant: 助手'."\n" + ."\n" + .'- system: 系统'."\n" + ."\n" + .'- function: 函数'."\n" + ."\n" + .'- plugin: 插件'."\n" + ."\n" + .'- tool: 工具', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'description' => '存储实际的对话内容文本，记录了该角色在对话中的具体表达或回应。', + 'type' => 'string', + 'example' => '你好', + ], + ], + ], + ], + 'WorkflowOverrideParams' => [ + 'description' => '工作流覆盖参数，默认无。', + 'type' => 'string', + 'example' => '{}', + ], + 'EnableIntelligentSegment' => [ + 'description' => '智能断句开关，开启智能断句后，用户说话的发生断句会智能合并成一句。默认为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VoiceIdList' => [ + 'description' => '可选音色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音色。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + 'CharBreak' => [ + 'type' => 'boolean', + ], + 'EnableVoiceInterrupt' => [ + 'description' => '是否支持语音打断，默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VoiceprintId' => [ + 'description' => '声纹识别的唯一身份ID。默认值：不填。', + 'type' => 'string', + 'example' => 'uniqueId', + ], + 'GracefulShutdown' => [ + 'description' => '是否优雅下线，默认false。'."\n" + ."\n" + .'优雅下线：当智能体被停止的时候，播报完当前说的话再停止，最多播报10秒。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InterruptWords' => [ + 'description' => '触发对话中断的特定词汇或短语列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'string', + 'example' => '停止', + ], + ], + 'UserOnlineTimeout' => [ + 'description' => '用户未入会，智能体超时关闭任务的时间。单位：秒。默认值：60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'AsrLanguageId' => [ + 'description' => 'asr语种Id。'."\n" + .'可选：'."\n" + .'- zh_mandarin 中文'."\n" + .'- en 英文'."\n" + .'- zh_en 中英混'."\n" + .'- es 西班牙语'."\n" + .'- jp 日语', + 'type' => 'string', + 'example' => 'zh_mandarin', + ], + 'UserOfflineTimeout' => [ + 'description' => '用户退会后，智能体超时关闭任务的时间。单位：秒。默认值：5秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LlmSystemPrompt' => [ + 'description' => '启动通话后llm的系统提示词。', + 'type' => 'string', + 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。'."\n", + ], + 'BailianAppParams' => [ + 'description' => '阿里云百炼应用中心参数。参数格式参考：[阿里云百炼应用中心参数](~~2858132~~)', + 'type' => 'string', + 'example' => '{}', + ], + 'VadLevel' => [ + 'description' => '打断阈值参数。取值范围：[0,11], 默认值：11。'."\n" + ."\n" + .'- 0表示关闭 vad 功能。'."\n" + .'- 1-10设置数字越高表示越难打断。'."\n" + .'- 11与之前显著不同，前处理对话音损伤更低，抗干扰更强。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LlmHistoryLimit' => [ + 'description' => 'llm/mllm历史对话上下文最大保留轮次，默认10次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AsrMaxSilence' => [ + 'description' => '语音断句检测阈值，静音时长超过该阈值会被认为断句，参数范围200ms～1200ms，默认值400ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'WakeUpQuery' => [ + 'description' => '用户在通话启动前的指令，用于智能体在通话启动后立即响应。', + 'type' => 'string', + 'example' => '今天天气怎么样？', + ], + 'Volume' => [ + 'description' => '智能体说话的音量。'."\n" + ."\n" + .'若不填：默认使用阿里云推荐的自适应音量模式'."\n" + ."\n" + .'若填写：填写范围为0~400，输出音量=工作流中的语音输出音量 * volume/100。示例：'."\n" + ."\n" + .'若volume=0，则代表输出音量为0。'."\n" + ."\n" + .'若volume=100，音量为原声音量。'."\n" + ."\n" + .'若volume=200，音量等于原声音量的2倍。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'VoiceId' => [ + 'description' => '音色ID，修改后下句话生效。不填写则使用智能体模版配置的音色ID。仅针对预置TTS生效。输入长度不超过64。[智能语音效果示例](~~449563~~)。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + 'UseVoiceprint' => [ + 'description' => '是否使用声纹识别的开关。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaxIdleTime' => [ + 'description' => '和智能体无互动的最大等待时间，超时智能体下线。单位：秒。默认：600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'AsrHotWords' => [ + 'description' => 'Asr热词列表。热词列表最大支持128个词。', + 'type' => 'array', + 'items' => [ + 'description' => '热词字符串。字符长度: [1,10]个字符', + 'type' => 'string', + 'example' => '检查', + ], + ], + 'EnablePushToTalk' => [ + 'description' => '是否开启对讲机模式。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'AvatarChat3D' => [ + 'title' => '3d数字人参数', + 'description' => '3d数字人参数', + 'type' => 'object', + 'properties' => [ + 'Greeting' => [ + 'title' => '问候语，修改后下次入会生效', + 'description' => '问候语，入会时生效。不填写则使用智能体模版配置的问候语。输入长度不超过128。', + 'type' => 'string', + 'example' => '早上好，我的朋友！', + ], + 'LlmHistory' => [ + 'description' => 'llm/mllm历史对话上下文最大保留轮次，默认10次。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '表示对话参与者的角色。可选值包括：'."\n" + ."\n" + .'- user: 用户'."\n" + ."\n" + .'- assistant: 助手'."\n" + ."\n" + .'- system: 系统'."\n" + ."\n" + .'- function: 函数'."\n" + ."\n" + .'- plugin: 插件'."\n" + ."\n" + .'- tool: 工具', + 'type' => 'string', + 'example' => 'user', + ], + 'Content' => [ + 'description' => '存储实际的对话内容文本，记录了该角色在对话中的具体表达或回应。', + 'type' => 'string', + 'example' => '你好', + ], + ], + ], + ], + 'WorkflowOverrideParams' => [ + 'description' => '工作流覆盖参数，默认无。', + 'type' => 'string', + 'example' => '{}', + ], + 'EnableIntelligentSegment' => [ + 'description' => '智能断句开关，开启智能断句后，用户说话的发生断句会智能合并成一句。默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VoiceIdList' => [ + 'description' => '可选音色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音色。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + 'AvatarId' => [ + 'title' => '数字人模型id', + 'description' => '数字人模型id', + 'type' => 'string', + 'example' => '1231', + ], + 'CharBreak' => [ + 'type' => 'boolean', + ], + 'EnableVoiceInterrupt' => [ + 'title' => '是否支持语音打断', + 'description' => '是否支持语音打断，默认true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VoiceprintId' => [ + 'description' => '声纹识别的唯一身份ID。默认值：不填。', + 'type' => 'string', + 'example' => 'uniqueId', + ], + 'GracefulShutdown' => [ + 'title' => '是否优雅下线', + 'description' => '是否优雅下线，默认false。'."\n" + ."\n" + .'- 优雅下线：当智能体被停止的时候，播报完当前说的话再停止，最多播报10秒。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InterruptWords' => [ + 'description' => '触发对话中断的特定词汇或短语列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发对话中断的特定词汇或短语。', + 'type' => 'string', + 'example' => '停止', + ], + ], + 'UserOnlineTimeout' => [ + 'description' => '用户未入会，智能体超时关闭任务的时间。单位：秒。默认值：60秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'AsrLanguageId' => [ + 'description' => 'asr语种Id。'."\n" + .'可选：'."\n" + .'- zh_mandarin 中文'."\n" + .'- en 英文'."\n" + .'- zh_en 中英混'."\n" + .'- es 西班牙语'."\n" + .'- jp 日语', + 'type' => 'string', + 'example' => 'zh_mandarin', + ], + 'UserOfflineTimeout' => [ + 'description' => '用户退会后，智能体超时关闭任务的时间。单位：秒。默认值：5秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LlmSystemPrompt' => [ + 'description' => '启动通话后llm的系统提示词。', + 'type' => 'string', + 'example' => '你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。', + ], + 'BailianAppParams' => [ + 'description' => '阿里云百炼应用中心参数。参数格式参考：[阿里云百炼应用中心参数](~~2858132~~)', + 'type' => 'string', + 'example' => '{}', + ], + 'VadLevel' => [ + 'description' => '打断阈值参数。取值范围：[0,11], 默认值：11。'."\n" + ."\n" + .'- 0表示关闭 vad 功能。'."\n" + .'- 1-10设置数字越高表示越难打断。'."\n" + .'- 11与之前显著不同，前处理对话音损伤更低，抗干扰更强。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LlmHistoryLimit' => [ + 'description' => 'llm/mllm历史对话上下文最大保留轮次，默认10次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AsrMaxSilence' => [ + 'description' => '语音断句检测阈值，静音时长超过该阈值会被认为断句，参数范围200ms～1200ms，默认值400ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'WakeUpQuery' => [ + 'description' => '用户在通话启动前的指令，用于智能体在通话启动后立即响应。', + 'type' => 'string', + 'example' => '今天天气怎么样？', + ], + 'Volume' => [ + 'title' => '音量', + 'description' => '智能体说话的音量。'."\n" + ."\n" + .'- 若不填：默认使用阿里云推荐的自适应音量模式'."\n" + ."\n" + .'- 若填写：填写范围为0~400，输出音量=工作流中的语音输出音量 * volume/100。示例：'."\n" + ."\n" + .'1. 若volume=0，则代表输出音量为0。'."\n" + .' '."\n" + .'2. 若volume=100，音量为原声音量。'."\n" + ."\n" + .'3. 若volume=200，音量等于原声音量的2倍。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'VoiceId' => [ + 'title' => '音色名称，修改后下句话生效', + 'description' => '音色ID，修改后下句话生效。不填写则使用智能体模版配置的音色ID。仅针对预置TTS生效。输入长度不超过64。可选值参考：[智能语音效果示例](~~449563~~)。', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + 'UseVoiceprint' => [ + 'description' => '是否使用声纹识别的开关。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaxIdleTime' => [ + 'description' => '和智能体无互动的最大等待时间，超时智能体下线。单位：秒。默认：600秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'AsrHotWords' => [ + 'description' => 'Asr热词列表。热词列表最大支持128个词。', + 'type' => 'array', + 'items' => [ + 'description' => '热词字符串。字符长度: [1,10]个字符', + 'type' => 'string', + 'example' => '检查', + ], + ], + 'EnablePushToTalk' => [ + 'description' => '是否开启对讲机模式。默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'AiRtcAuthCodeDTO' => [ + 'title' => 'A short description of struct', + 'description' => '授权码信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '状态', + 'description' => '状态：'."\n" + ."\n" + .'- 1 - 激活'."\n" + .'- 2 - 未激活', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型：'."\n" + ."\n" + .'- 1 - 语音通话'."\n" + .'- 2 - 视觉理解', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthCode' => [ + 'title' => '授权码', + 'description' => '授权码。', + 'type' => 'string', + 'example' => 'iU1IeJech7***', + ], + 'ActivatedTime' => [ + 'title' => '激活时间', + 'description' => '激活时间。', + 'type' => 'string', + 'example' => '2024-01-01 06:57:43', + ], + 'DeviceId' => [ + 'title' => '设备ID', + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'device-***', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-12-23T13:33:49Z', + ], + 'License' => [ + 'title' => 'license', + 'description' => 'license。', + 'type' => 'string', + 'example' => 'a659a06659a***', + ], + 'ModificationTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-12-23T13:33:49Z', + ], + 'LicenseItemId' => [ + 'title' => '批次ID', + 'description' => '批次ID。', + 'type' => 'string', + 'example' => '11096067***', + ], + ], + ], + 'AiRtcLicenseInfoDTO' => [ + 'title' => 'A short description of struct', + 'description' => '批次信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + 'ModificationTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型：'."\n" + ."\n" + .'- 1 - 语音通话'."\n" + .'- 2 - 视觉理解', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LicenseItemId' => [ + 'title' => '批次ID', + 'description' => '批次ID。', + 'type' => 'string', + 'example' => '17712***', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态：'."\n" + ."\n" + .'- 1 - 正常'."\n" + .'- 2 - 过期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ValidDays' => [ + 'title' => '有效天数', + 'description' => '有效天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '365', + ], + 'ExpiredOn' => [ + 'title' => '过期时间', + 'description' => '过期时间。', + 'type' => 'string', + 'example' => '2021-12-23T13:33:49Z', + ], + 'BeginOn' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + 'LicenseCount' => [ + 'title' => 'license数量', + 'description' => 'license数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'AvailableCapacity' => [ + 'title' => '可用容量', + 'description' => '可用容量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'ice_CoverAILicense_public_cn***', + ], + 'ContractNo' => [ + 'title' => '合同号', + 'description' => '合同号。', + 'type' => 'string', + 'example' => '258396267390***', + ], + ], + ], + 'AppInfoDTO' => [ + 'title' => 'A short description of struct', + 'description' => '应用信息', + 'type' => 'object', + 'properties' => [ + 'Platforms' => [ + 'title' => '应用包含的平台信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '平台类型', + 'type' => 'integer', + 'format' => 'int64', + ], + 'LicenseItemIds' => [ + 'title' => '授权列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '授权itemId', + ], + ], + 'PkgSignature' => [ + 'title' => '包签名', + 'type' => 'string', + ], + 'PlatformType' => [ + 'title' => '平台类型', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ItemId' => [ + 'title' => '平台标志', + 'type' => 'string', + ], + 'PkgName' => [ + 'title' => '包名', + 'type' => 'string', + ], + ], + ], + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'GmtModified' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'ModificationTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'AppType' => [ + 'title' => '应用类型', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1-普通应用，2-内嵌SDK.', + ], + 'ItemId' => [ + 'title' => '应用标识', + 'type' => 'string', + ], + 'AppName' => [ + 'title' => '应用名称', + 'type' => 'string', + ], + ], + ], + 'Channel' => [ + 'description' => '频道组装频道。', + 'type' => 'object', + 'properties' => [ + 'FillerSourceName' => [ + 'description' => '垫片源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'FillerSourceLocationName' => [ + 'description' => '垫片源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-01-15T03:44:16Z', + ], + 'ChannelName' => [ + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'ChannelTier' => [ + 'description' => '频道等级。', + 'type' => 'string', + 'example' => 'basic', + ], + 'AccessToken' => [ + 'description' => '频道播放Token。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'State' => [ + 'description' => '频道状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => '修改日期', + 'type' => 'string', + 'example' => '2024-09-01T10:09Z', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:channel/myChannel', + ], + 'PlaybackMode' => [ + 'description' => '播放模式。', + 'type' => 'string', + 'example' => 'loop', + ], + 'OutPutConfigList' => [ + 'description' => '输出配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输出配置。', + 'type' => 'object', + 'properties' => [ + 'ManifestName' => [ + 'description' => '清单名称', + 'type' => 'string', + 'example' => 'index1', + ], + 'ChannelName' => [ + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'Format' => [ + 'description' => '格式。', + 'type' => 'string', + 'example' => 'hls', + ], + 'PlaybackUrl' => [ + 'description' => '播放地址。', + 'type' => 'string', + 'example' => 'https://xxxxx.com/xxx.m3u8', + ], + 'ManifestSettings' => [ + 'description' => 'manifest配置。', + 'type' => 'string', + 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}', + ], + 'SourceGroupName' => [ + 'description' => '源组名称。', + 'type' => 'string', + 'example' => 'group1', + ], + ], + ], + ], + 'AccessPolicy' => [ + 'description' => '是否开启访问控制。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ChannelAssemblyChannel' => [ + 'description' => '频道组装频道。', + 'type' => 'object', + 'properties' => [ + 'FillerSourceName' => [ + 'description' => '垫片源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'FillerSourceLocationName' => [ + 'description' => '垫片源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-01-15T03:44:16Z'."\n", + ], + 'ChannelName' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'ChannelTier' => [ + 'description' => '频道等级。', + 'type' => 'string', + 'example' => 'basic', + ], + 'AccessToken' => [ + 'description' => '频道播放Token。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'State' => [ + 'description' => '频道状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-09-01T10:09Z'."\n", + ], + 'Arn' => [ + 'description' => 'ARN资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:channel/myChannel'."\n", + ], + 'PlaybackMode' => [ + 'description' => '播放模式。', + 'type' => 'string', + 'example' => 'loop', + ], + 'OutPutConfigList' => [ + 'description' => '频道输出配置。', + 'type' => 'array', + 'items' => [ + 'description' => '输出配置。', + 'type' => 'object', + 'properties' => [ + 'ManifestName' => [ + 'description' => '清单名称。', + 'type' => 'string', + 'example' => 'index1', + ], + 'ChannelName' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'Format' => [ + 'description' => '输出格式。', + 'type' => 'string', + 'example' => 'hls', + ], + 'PlaybackUrl' => [ + 'description' => '播放地址。', + 'type' => 'string', + 'example' => 'https://xxxxx.com/xxx.m3u8'."\n", + ], + 'ManifestSettings' => [ + 'description' => 'manifest配置。', + 'type' => 'string', + 'example' => '{"WindowDuration": 60,"AdMarkType":"Daterange"}'."\n", + ], + 'SourceGroupName' => [ + 'description' => '源组名称。', + 'type' => 'string', + 'example' => 'group1', + ], + ], + ], + ], + 'AccessPolicy' => [ + 'description' => '是否开启访问控制。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ChannelAssemblyProgram' => [ + 'description' => '节目信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-04-02T00:58:19Z'."\n", + ], + 'ChannelName' => [ + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'AdBreaks' => [ + 'description' => '广告。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeSignalSettings' => [ + 'description' => 'TimeSignal配置。', + 'type' => 'string', + 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", + ], + 'OffsetMillis' => [ + 'description' => '偏移量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ChannelName' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'SpliceInsertSettings' => [ + 'description' => 'SpliceInsert配置。', + 'type' => 'string', + 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MyAdSource', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program_name'."\n", + ], + 'MessageType' => [ + 'description' => '消息类型。', + 'type' => 'string', + 'example' => 'SPLICE_INSERT', + ], + ], + ], + ], + 'SourceType' => [ + 'description' => '源类型。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'Transition' => [ + 'description' => '节目位置。', + 'type' => 'string', + 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}'."\n", + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-04-02T00:58:19Z'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'ClipRange' => [ + 'description' => '片段信息。', + 'type' => 'string', + 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", + ], + 'Arn' => [ + 'description' => '节目资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:program/myChannel/MyProgram'."\n", + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program1', + ], + ], + ], + 'ChannelAssemblyScheduleData' => [ + 'description' => '日程信息。', + 'type' => 'object', + 'properties' => [ + 'EntryType' => [ + 'description' => '日程类型。', + 'type' => 'string', + 'example' => 'program', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation'."\n", + ], + 'AdBreaks' => [ + 'description' => '广告信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OffsetMillis' => [ + 'description' => '偏移时间。', + 'type' => 'string', + 'example' => '100000', + ], + 'TimeSignalSettings' => [ + 'description' => 'TimeSignal配置。', + 'type' => 'string', + 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}'."\n", + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'SpliceInsertSettings' => [ + 'description' => 'SpliceInsert配置。', + 'type' => 'string', + 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'MessageType' => [ + 'description' => 'MessageType', + 'type' => 'string', + 'example' => 'SPLICE_INSERT', + ], + ], + ], + ], + 'SourceType' => [ + 'description' => '源类型。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'ApproximateDurationSeconds' => [ + 'description' => '预计播放时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'ApproximateStartTime' => [ + 'description' => '预计播放开始时间。', + 'type' => 'string', + 'example' => '1989128002313', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program1', + ], + ], + ], + 'ChannelAssemblySource' => [ + 'description' => '源信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-10-20T07:15:51Z', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation'."\n", + ], + 'State' => [ + 'description' => '源状态，0表示正常，1表示删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SourceType' => [ + 'description' => '源类型。vodSource，liveSource。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-11-07T10:12:01Z'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MyVodSource'."\n", + ], + 'HttpPackageConfigurations' => [ + 'description' => '源配置。', + 'type' => 'string', + 'example' => '[{'."\n" + .' "sourceGroupName": "mySourceGroup-1",'."\n" + .' "relativePath": "group1/hls.m3u8",'."\n" + .' "packageType": "hls"'."\n" + .'}]', + ], + 'Arn' => [ + 'description' => '源资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/mySource'."\n", + ], + ], + ], + 'ChannelAssemblySourceLocation' => [ + 'description' => '源位置信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-29T02:03:17Z', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation'."\n", + ], + 'State' => [ + 'description' => '源位置状态，0：正常，1：已删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-03-29T02:03:17Z'."\n", + ], + 'SegmentDeliveryConfigurations' => [ + 'description' => '切片传输配置。', + 'type' => 'string', + 'example' => 'http://segmentdelivery.com'."\n", + ], + 'BaseUrl' => [ + 'description' => '源位置Url。', + 'type' => 'string', + 'example' => 'http://xxxx.com'."\n", + ], + 'Arn' => [ + 'description' => '源位置资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<UserId>:sourcelocation/MySourceLocation'."\n", + ], + ], + ], + 'EntityMediaBasicInfo' => [ + 'type' => 'object', + 'properties' => [ + 'EntityMediaId' => [ + 'type' => 'string', + ], + 'EntityId' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + 'Biz' => [ + 'type' => 'string', + ], + 'AppId' => [ + 'type' => 'string', + ], + 'UserData' => [ + 'type' => 'string', + ], + 'ModifiedTime' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + ], + ], + 'Hotword' => [ + 'description' => '热词信息', + 'type' => 'object', + 'properties' => [ + 'TranspositionResultList' => [ + 'description' => '- 翻译转置的结果'."\n" + .'- 该参数仅用于视频翻译功能场景', + 'type' => 'array', + 'items' => [ + 'description' => '翻译转置结果', + '$ref' => '#/components/schemas/TranspositionResult', + ], + ], + 'Language' => [ + 'title' => '目标热词语种', + 'description' => '热词文本的语种，支持的语种范围：'."\n" + ."\n" + .'- 结构化媒资理解：'."\n" + .'zh：中文'."\n" + .'en：英文'."\n" + .'- 视频翻译：支持的语种语言详见源语种列表，共53个语种'."\n" + .'- ASR智能字幕：和“结构化媒资理解”相同', + 'type' => 'string', + 'example' => 'en', + ], + 'Text' => [ + 'title' => '热词原始文案', + 'description' => '热词文本。'."\n" + ."\n" + .'- 结构化媒资理解：'."\n" + .'- - 中文：15个字符，一个中文汉字=1字符'."\n" + .'- - 英文：10个单词，单词之间用空格隔开'."\n" + .'- - 中英混的情况，完全按中文算，一个字母即一个字符'."\n" + .'- 视频翻译：长度上限100字符'."\n" + .'- ASR智能字幕：和“结构化媒资理解”相同', + 'type' => 'string', + 'example' => 'hello', + ], + 'Weight' => [ + 'description' => '热词对应的权重。'."\n" + ."\n" + .'说明：'."\n" + .'1. 权重取值范围[-6,5]'."\n" + .'2. 取值大于0会增大该词语被识别的概率，小于0会减小该词语被识别的概率'."\n" + .'3. 取值为-6：表示尽量不要识别出该词语'."\n" + .'4. 取值为2：常用值'."\n" + .'5. 如果效果不明显，可以适当增加权重，但是当权重较大时可能会引起负面效果，导致其他词语识别不准确', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'LicenseInstanceAppDTO' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => 'status', + 'type' => 'string', + ], + 'AppId' => [ + 'title' => 'appId', + 'type' => 'string', + ], + 'ContractNo' => [ + 'title' => 'contractNo', + 'type' => 'string', + ], + 'InstanceId' => [ + 'title' => 'instanceId', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => 'userId', + 'type' => 'integer', + 'format' => 'int64', + ], + 'CreationTime' => [ + 'title' => 'creationTime', + 'type' => 'string', + ], + 'BeginOn' => [ + 'title' => 'beginOn', + 'type' => 'string', + ], + 'ModificationTime' => [ + 'title' => 'modificationTime', + 'type' => 'string', + ], + 'ItemId' => [ + 'title' => 'itemId', + 'type' => 'string', + ], + 'ExpiredOn' => [ + 'title' => 'expiredOn', + 'type' => 'string', + ], + 'LicenseConfigs' => [ + 'title' => 'LicenseConfigDTOS', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FeatureIds' => [ + 'title' => 'featureIds', + 'type' => 'string', + ], + 'SdkId' => [ + 'title' => 'sdkId', + 'type' => 'integer', + 'format' => 'int32', + ], + 'IsTrial' => [ + 'type' => 'boolean', + ], + 'SdkName' => [ + 'title' => 'sdkName', + 'type' => 'string', + ], + 'BusinessType' => [ + 'title' => 'businessType', + 'type' => 'string', + ], + 'Subscription' => [ + 'title' => 'subscription', + 'type' => 'string', + ], + 'SubscriptionImp' => [ + 'title' => 'subscriptionImp', + 'type' => 'string', + ], + 'SubscriptionPkg' => [ + 'title' => 'subscriptionPkg', + 'type' => 'string', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'ListMediaQualityAnalysisJobsResponseItem' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'JobId' => [ + 'type' => 'string', + ], + 'ScheduleConfig' => [ + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'type' => 'string', + ], + 'Priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'TemplateConfig' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'type' => 'string', + ], + ], + ], + 'State' => [ + 'type' => 'string', + ], + 'UserData' => [ + 'type' => 'string', + ], + 'Input' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'Media' => [ + 'type' => 'string', + ], + ], + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'FinishTime' => [ + 'type' => 'string', + ], + ], + ], + 'LiveManifestConfig' => [ + 'description' => '直播清单配置', + 'type' => 'object', + 'properties' => [ + 'SegmentCount' => [ + 'description' => '切片个数，适用HLS/HLS_CMAF协议，默认使用channel的配置，取值范围：2～100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AdMarkers' => [ + 'description' => '播放清单中支持的广告标记。'."\n" + .'- NONE：去除广告标记'."\n" + .'- DATE_RANGE：使用HLS规范中的EXT-X-DATERANGE标记，端点协议为HLS/HLS_CMAF时可用'."\n" + .'- XML：使用DASH规范中的XML广告标记，端点协议为DASH可用', + 'type' => 'string', + 'enumValueTitles' => [ + 'XML' => 'XML', + 'NONE' => 'NONE', + 'DATE_RANGE' => 'DATE_RANGE', + ], + 'example' => 'NONE', + ], + 'MinVideoBitrate' => [ + 'description' => '输入最小比特率阈值（单位：比特/秒），视频轨道必须大于或者等于此阈值才能从此端点播放。取值范围：大于0的整数。默认为空不设置最小比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000000', + ], + 'MinBufferTime' => [ + 'description' => '最小缓冲时间，单位：秒。取值范围：1～30。默认2个切片时长。仅适用DASH。'."\n" + ."\n" + .'注意：最小缓冲时间过小可能导致播放卡顿，建议不小于2个切片时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'PresentationDelay' => [ + 'description' => '建议启播延迟，单位：秒。取值范围：1～60。默认3个切片时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'StreamOrder' => [ + 'description' => '流排序规则，支持值：'."\n" + .'- ORIGINAL：保持输入的子清单排序；'."\n" + .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" + .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', + 'type' => 'string', + 'enumValueTitles' => [ + 'VIDEO_BITRATE_ASCENDING' => 'VIDEO_BITRATE_ASCENDING', + 'VIDEO_BITRATE_DESCENDING' => 'VIDEO_BITRATE_DESCENDING', + 'ORIGINAL' => 'ORIGINAL', + ], + 'example' => 'ORIGINAL', + ], + 'MaxVideoBitrate' => [ + 'description' => '输入最大比特率阈值（单位：比特/秒），视频轨道必须小于等于此阈值才能从此端点播放。取值范围：大于0的整数。默认为空不限制最大比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8000000', + ], + 'DateTimeInterval' => [ + 'description' => '插入时间标签EXT-X-PROGRAM-DATE-TIME的间隔（秒）。默认不插入标签。取值范围：1～3600。适用HLS/HLS_CMAF协议。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SegmentTemplateFormat' => [ + 'description' => '切片模版，暂只支持NUMBER_TIMELINE（默认）。适用DASH。', + 'type' => 'string', + 'enumValueTitles' => [ + 'NUMBER_TIMELINE' => 'NUMBER_TIMELINE', + ], + 'example' => 'NUMBER_TIMELINE', + ], + 'MinUpdatePeriod' => [ + 'description' => '最小更新间隔。单位：秒。取值范围：1～3600。默认2个切片时长。适用DASH。'."\n" + ."\n" + .'注意：建议设置为小于最小缓冲时间，过大会导致DASH播放卡顿。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'ManifestDuration' => [ + 'description' => '直播过程中最大回看时长。单位：秒。取值范围：1～3600，默认60。适用DASH。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + ], + 'LivePackagingConfig' => [ + 'description' => '直播封装配置', + 'type' => 'object', + 'properties' => [ + 'LiveManifestConfigs' => [ + 'description' => '直播清单配置，目前最多支持一个', + 'type' => 'array', + 'items' => [ + 'description' => '直播清单配置', + '$ref' => '#/components/schemas/LiveManifestConfig', + ], + ], + 'UseAudioRenditionGroups' => [ + 'title' => 'TS切片是否分离音频轨', + 'description' => 'TS切片是否分离音频轨', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DrmConfig' => [ + 'title' => 'DRM加密提供商配置。', + 'description' => 'DRM加密提供商配置，如不加密，所有字段留空', + 'type' => 'object', + 'properties' => [ + 'SystemIds' => [ + 'title' => 'drm 系统id，system id数量由使用的协议类型决定。'."\n" + .'- DASH -- 最多两个'."\n" + .'- HLS -- 提供一个'."\n" + .'- HLS_CMAF-- 最多提供两个。'."\n" + .'只支持 Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM System，对应SystemId分别为 ：'."\n" + .'Apple FairPlay：'."\n" + .'94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" + .'Google Widevine：'."\n" + .'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" + .'Microsoft PlayReady：'."\n" + .'9a04f079-9840-4286-ab92-e65be0885f95。', + 'description' => 'DRM系统ID，由使用的协议类型决定。'."\n" + .'- DASH -- 支持Google Widevine、Microsoft PlayReady'."\n" + .'- HLS -- 暂不支持'."\n" + .'- HLS_CMAF -- 支持Apple FairPlay、Google Widevine、Microsoft PlayReady'."\n" + ."\n" + .'支持Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM系统，对应系统ID分别为 ：'."\n" + .'- Apple FairPlay：'."\n" + .'94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" + .'- Google Widevine：'."\n" + .'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" + .'- Microsoft PlayReady：'."\n" + .'9a04f079-9840-4286-ab92-e65be0885f95。', + 'type' => 'array', + 'items' => [ + 'description' => 'DRM系统ID', + 'type' => 'string', + 'example' => '9a04f079-9840-4286-ab92-e65be0885f95', + ], + ], + 'RotatePeriod' => [ + 'title' => 'DRM key轮转间隔，单位：秒', + 'description' => 'DRM密钥轮转间隔，单位：秒。默认为0，密钥不轮换。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ContentId' => [ + 'description' => 'DRM系统中的内容ID，格式：[A-Za-z0-9_-]+，长度最多256。客户需确保内容ID的唯一性，否则DRM播放可能失败。', + 'type' => 'string', + 'example' => 'live-axb1-9dd2fa123', + ], + 'EncryptionMethod' => [ + 'title' => '加密算法，支持值：'."\n" + .'- AES_128'."\n" + .'- SAMPLE_AES', + 'description' => '加密算法，支持值：'."\n" + .'- SAMPLE_AES'."\n" + ."\n" + .'默认为空，即不加密。', + 'type' => 'string', + 'example' => 'SAMPLE_AES', + ], + 'IV' => [ + 'title' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', + 'description' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', + 'type' => 'string', + 'example' => '00000000000000000000000000000000', + ], + 'Url' => [ + 'title' => 'DRM key提供商url。', + 'description' => 'DRM密钥提供商URL', + 'type' => 'string', + 'example' => 'https://exampledrm.com/path?arg1=xxx', + ], + ], + ], + 'SegmentDuration' => [ + 'title' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', + 'description' => '每个切片的时长（以秒为单位），默认为频道切片时长。实际切片时长为最接近源片段时长的倍数，大于等于配置值。取值范围【1，30】', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + 'MediaConvertAudio' => [ + 'description' => '音频转码参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式。'."\n" + .'● 可选值：AAC、AC3、EAC3、MP2、MP3、FLAC、OPUS、VORBIS、WMA-V1、WMA-V2、pcm_s16le。'."\n" + .'● 默认值：AAC。', + 'description' => '音频编解码格式。'."\n" + .'- 可选值：AAC、AC3、EAC3、MP2、MP3、FLAC、OPUS、VORBIS、WMA-V1、WMA-V2、pcm_s16le。'."\n" + .'- 默认值：AAC。', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Remove' => [ + 'title' => '是否删除音频流。'."\n" + .'● true：删除。则本节所有Audio相关参数失效。'."\n" + .'● false：保留。'."\n" + .'● 默认值：false。', + 'description' => '是否删除音频流。'."\n" + .'- true：删除。则本节所有Audio相关参数失效。'."\n" + .'- false：保留。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .'● 单位：Kbps。'."\n" + .'● 值范围：[8,1000]。'."\n" + .'● 默认值：128。'."\n" + .'● 常见值：64、128、256。', + 'description' => '输出文件的音频码率。'."\n" + .'- 单位：Kbps。'."\n" + .'- 值范围：[8,1000]。'."\n" + .'- 默认值：128。'."\n" + .'- 常见值：64、128、256。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '128', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .'● 单位：Hz。'."\n" + .'可选值：22050、32000、44100、48000、96000。'."\n" + .'● 说明'."\n" + .'不同封装和编码格式支持的采样率不同，完整信息请参见采样率支持。例如：音频Codec为MP3时，所有封装格式的采样率不支持96000，且封装格式为FLV时，采样率仅支持22050、44100。'."\n" + .'● 默认值：44100', + 'description' => '采样率。'."\n" + .'- 单位：Hz。'."\n" + .'- 可选值：22050、32000、44100、48000、96000。'."\n" + .'- 默认值：44100'."\n" + ."\n" + .'说明：不同封装和编码格式支持的采样率不同，完整信息请参见采样率支持。例如：音频Codec为MP3时，所有封装格式的采样率不支持96000，且封装格式为FLV时，采样率仅支持22050、44100。', + 'type' => 'string', + 'example' => '44100', + ], + 'Profile' => [ + 'title' => '音频编码级别。'."\n" + .'● 仅Codec为AAC时生效。'."\n" + .'● 可选值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。更多信息请参见基本概念。'."\n" + .'● 默认值：aac_low。', + 'description' => '音频编码级别。'."\n" + .'- 仅Codec为AAC时生效。'."\n" + .'- 可选值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。更多信息请参见基本概念。'."\n" + .'- 默认值：aac_low。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .'● 可选值：0、1、2、4、5、6、8。'."\n" + .' ○ 音频Codec为MP3、OPUS时，支持0、1、2。'."\n" + .' ○ 音频Codec为AAC、FLAC时，支持0、1、2、4、5、6、8。'."\n" + .' ○ 音频Codec为VORBIS时，支持2。'."\n" + .' ○ Format为mpd时，不支持8。'."\n" + .'● 默认值：2。'."\n" + .'● 若要保留原声道数，请设置为0。', + 'description' => '声道数。'."\n" + .'- 可选值：0、1、2、4、5、6、8。'."\n" + .' - 音频Codec为MP3、OPUS时，支持0、1、2。'."\n" + .' - 音频Codec为AAC、FLAC时，支持0、1、2、4、5、6、8。'."\n" + .' - 音频Codec为VORBIS时，支持2。'."\n" + .' - Format为mpd时，不支持8。'."\n" + .'- 默认值：2。'."\n" + .'- 若要保留原声道数，请设置为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'MediaConvertInput' => [ + 'title' => '转码输入', + 'description' => '转码输入', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '输入文件名称。Output 中有 InputRef 时，可以使用该名称实现对输入文件的引用。', + 'type' => 'string', + 'example' => 'InputVideo', + ], + 'InputFile' => [ + 'title' => '输入文件', + 'description' => '输入文件', + '$ref' => '#/components/schemas/MediaObject', + ], + ], + ], + 'MediaConvertJob' => [ + 'description' => 'MediaConvertJob 结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '创建转码作业的请求ID', + 'description' => '创建转码作业的请求ID', + 'type' => 'string', + 'example' => '7B117AF5-2A1******', + ], + 'ClientToken' => [ + 'title' => '创建转码作业请求的幂等参数', + 'description' => '创建转码作业请求的幂等参数', + 'type' => 'string', + 'example' => '****12e8864746a0a398****', + ], + 'JobId' => [ + 'title' => '转码作业 ID', + 'description' => '转码作业 ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'Config' => [ + 'description' => '转码作业配置', + '$ref' => '#/components/schemas/MediaConvertJobConfig', + ], + 'PipelineId' => [ + 'title' => '管道ID', + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'title' => '作业失败码', + 'description' => '作业失败码', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad'."\n", + ], + 'Message' => [ + 'title' => '作业失败详细信息', + 'description' => '作业失败详细信息', + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad'."\n", + ], + 'State' => [ + 'title' => '转码作业状态。'."\n" + .'● Inited : 初始化；'."\n" + .'● Running : 运行中；'."\n" + .'● Success : 转码成功；'."\n" + .'● Failed : 转码失败；'."\n" + .'● Cancelled : 已取消'."\n", + 'description' => '转码作业状态。'."\n" + .'- Inited : 初始化；'."\n" + .'- Running : 运行中；'."\n" + .'- Complete : 转码成功；'."\n" + .'- Error : 转码失败；'."\n" + .'- Cancelled : 已取消。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-07-07T07:16:11Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2022-07-07T07:16:11Z'."\n", + ], + 'Percent' => [ + 'description' => '任务完成百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OutputDetails' => [ + 'title' => '转码输出结果详情', + 'description' => '转码输出结果详情', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出结果', + 'description' => '转码输出结果', + '$ref' => '#/components/schemas/MediaConvertOutputDetail', + ], + ], + 'OutputGroupDetails' => [ + 'title' => '转码输出组结果列表', + 'description' => '转码输出组结果列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出组结果', + 'description' => '转码输出组结果', + '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', + ], + ], + ], + ], + 'MediaConvertJobConfig' => [ + 'description' => '媒体转码任务配置', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => '任务名称。'."\n" + .'- 最大长度为64字节。', + 'type' => 'string', + 'example' => 'Name', + ], + 'Inputs' => [ + 'description' => '转码作业输入列表', + 'type' => 'array', + 'items' => [ + 'description' => '转码作业输入', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '输入文件名称。在 Output 中使用 InputRef时，可引用此名称。', + 'type' => 'string', + 'example' => 'InputVideo'."\n", + ], + 'InputFile' => [ + 'description' => '输入文件', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体文件类型。取值：'."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资文件。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '媒资文件URL或ID。'."\n" + ."\n" + .'- 当Type为OSS类型时，media为URL（支持OSS/HTTP协议），请勿带签名参数，否则可能导致权限校验失败。 '."\n" + .'- 当Type为media类型时，media为媒资ID，默认使用源流输入。', + 'type' => 'string', + 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + 'OutputGroups' => [ + 'description' => '转码作业输出组配置列表', + 'type' => 'array', + 'items' => [ + 'description' => '转码作业输出组配置', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '输出组名称', + 'type' => 'string', + 'example' => 'hls-group'."\n", + ], + 'GroupConfig' => [ + 'description' => '组信息配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出组类型，取值：'."\n" + ."\n" + .'- File：独立文件。'."\n" + .'- Hls：HLS协议文件（生成自适应播放流）。', + 'type' => 'string', + 'enumValueTitles' => [ + 'File' => 'File', + 'Hls' => 'Hls', + ], + 'example' => 'Hls', + ], + 'OutputFileBase' => [ + 'description' => '组输出目录。该 OutputGroup 产生的文件都会在该目录下。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体对象类型，支持：'."\n" + ."\n" + .'- OSS: 阿里云 oss 文件'."\n" + .'- Media: 媒资', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '文件媒资'."\n" + ."\n" + .'- Type 为 OSS 时，media 为 URL，且支持 OSS 协议和 HTTP 协议。'."\n" + .'- Type 为 Media 时，media 为媒资 ID。默认使用源流作为输入。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/dir', + ], + ], + ], + 'ManifestName' => [ + 'description' => '清单文件名称。当 Type Hls 或 Dash 时，用来指定生成的 manifest 文件的文件名。', + 'type' => 'string', + 'example' => 'manifest', + ], + 'ManifestExtend' => [ + 'description' => '清单文件扩展功能配置。该功能支持引用一个已存在的清单文件，并在此基础上结合当前输出组结果，生成新的清单文件。', + 'type' => 'object', + 'properties' => [ + 'InputRef' => [ + 'description' => '被引用的清单文件，其值为 Input 的name。', + 'type' => 'string', + 'example' => 'Input-Manifest', + ], + 'Excludes' => [ + 'description' => '用来排除引用清单文件中的流。条件内部采用与的逻辑，条件之间采用或的逻辑进行筛选。', + 'type' => 'array', + 'items' => [ + 'description' => '流排除条件。', + 'type' => 'object', + 'properties' => [ + 'Language' => [ + 'description' => '按流的 Language 字段查找被筛选项，遵循 RFC5646 标准。', + 'type' => 'string', + 'example' => 'en', + ], + 'Name' => [ + 'description' => '按流的Name字段查找被筛选项。', + 'type' => 'string', + 'example' => 'audio-1', + ], + 'Type' => [ + 'description' => '按流的Type字段查找被筛选项。'."\n" + ."\n" + .'取值：'."\n" + .'- Audio。'."\n" + .'- Subtitle。', + 'type' => 'string', + 'example' => 'Audio', + ], + ], + ], + ], + ], + ], + ], + ], + 'Outputs' => [ + 'description' => '单路输出转码配置列表，数组每个配置表示一个输出流文件。', + 'type' => 'array', + 'items' => [ + 'description' => '单路输出转码配置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '转码输出名称，仅用于标记输出。', + 'type' => 'string', + 'example' => 'group-output'."\n", + ], + 'TemplateId' => [ + 'description' => '转码模板 ID', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****'."\n", + ], + 'OutputFileName' => [ + 'description' => '转码输出文件名。配合 GroupConfig 中 OutputFileBase 一起使用。', + 'type' => 'string', + 'example' => '720p.mp4'."\n", + ], + 'Priority' => [ + 'description' => '优先级，数值越大优先级越高，取值：[1,10]，默认值为6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Features' => [ + 'description' => '功能参数，详情请参见[MediaConvertJobFeature](~~2979993~~)。', + 'type' => 'string', + 'example' => '{}', + ], + 'OverrideParams' => [ + 'description' => '覆盖参数（JSON 字符串），支持对转码模板关联的参数覆盖。', + 'type' => 'string', + 'example' => '{}', + ], + 'HlsGroupConfig' => [ + 'description' => 'Hls 组配置。配置当前流在 Manifest 中的行为。仅当组类型为 Hls 时有效。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '指定输出流类型：'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- video：视频流，处理时将仅保留与视频相关的设置。'."\n" + .'- audio：音频流，处理时将仅保留与音频相关的设置。'."\n" + .'- subtitle：字幕流，处理时将仅保留与字幕相关的设置。'."\n" + .'- hybrid：混合流，处理时将保留与音频和视频相关的设置。'."\n" + ."\n" + .'默认值：hybrid。', + 'type' => 'string', + 'example' => 'hybrid', + ], + 'AudioGroup' => [ + 'description' => '该路视频流引用的音频组。当Type为 video 生效。'."\n" + ."\n" + .'默认值： audio', + 'type' => 'string', + 'example' => 'audio', + ], + 'SubtitleGroup' => [ + 'description' => '该路视频流引用的字幕组。当Type为 video 和 hybrid 时生效。'."\n" + ."\n" + .'默认值：subtitle', + 'type' => 'string', + 'example' => 'subtitle', + ], + 'Name' => [ + 'description' => '该输出流在 HLS manifest 中的 NAME 属性。当Type为 audio 或 subtitle 时，此项为**必填**。', + 'type' => 'string', + 'example' => 'audio', + ], + 'Group' => [ + 'description' => '该输出流在 HLS Manifest 中的 GROUP_ID 属性。该属性在 Type 为 audio 和 subtitle 时生效。'."\n" + ."\n" + .'默认与 Type 的取值相同。', + 'type' => 'string', + 'example' => 'audio', + ], + 'Language' => [ + 'description' => '该输出流在 HLS manifest 中的 LANGUAGE 属性，当Type为 audio 和 subtitle 时生效，需遵循 RFC 5646 标准。', + 'type' => 'string', + 'example' => 'zh', + ], + 'IsDefault' => [ + 'description' => '是否设为默认流。当Type为 audio 和 subtitle 时生效。同一个 Group 中只能有一个默认流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Forced' => [ + 'description' => '是否强制显示。当Type为 audio 和 subtitle 时生效。', + 'type' => 'string', + 'example' => 'true', + ], + 'AutoSelect' => [ + 'description' => '是否自动选择流。当Type为 audio 和 subtitle 时生效。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'MediaConvertJobFeature' => [ + 'description' => '转码功能参数。', + 'type' => 'object', + 'properties' => [ + 'Clip' => [ + 'description' => '剪辑片段。', + 'type' => 'object', + 'properties' => [ + 'TimeSpan' => [ + 'description' => '剪辑时间区间。', + 'type' => 'object', + 'properties' => [ + 'Seek' => [ + 'description' => '开始时间点。可以设置剪辑的开始时间点。默认从开头截取。'."\n" + .'- 格式：hh:mm:ss[.SSS]或sssss[.SSS]。'."\n" + .'- 值范围：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。'."\n" + .'- 示例：00:01:59.999或180.30。', + 'type' => 'string', + 'example' => '180.30', + ], + 'Duration' => [ + 'description' => '持续时长。可以设置相对于开始时间点（Seek）的剪辑时长。默认从开始时间点（Seek）到结尾的全部内容。Duration和End参数只支持二选一，设置End则Duration失效。'."\n" + .'- 格式：hh:mm:ss[.SSS]或sssss[.SSS]。'."\n" + .'- 值范围：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。'."\n" + .'- 示例：00:01:59.99 或180.30。', + 'type' => 'string', + 'example' => '60.0', + ], + 'End' => [ + 'description' => '截尾时长，表示切掉尾部的若干时长。Duration和End参数只支持二选一，设置End则Duration失效。'."\n" + ."\n" + .'- 格式：hh:mm:ss[.SSS]或sssss[.SSS]。'."\n" + .'- 值范围：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。'."\n" + .'- 示例：00:01:59.999或180.30。', + 'type' => 'string', + 'example' => '50', + ], + ], + ], + 'ConfigToClipFirstPart' => [ + 'description' => '是否对第一个剪辑片段进行剪辑。'."\n" + .'- true：先剪辑第一个片段，再拼接（转码）。'."\n" + .'- false：先拼接（转码），再剪辑。'."\n" + .'- 默认值：false。', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + 'Watermarks' => [ + 'description' => '水印列表，将图片或文字压制到画面中。如设置则覆盖指定水印模板中的对应参数。'."\n" + .'- 一次转码任务最多添加4个水印。', + 'type' => 'array', + 'items' => [ + 'description' => '水印设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '水印类型。'."\n" + .'- Text：文字水印。此时必须设置文字水印相关参数。'."\n" + .'- Image：图片水印。此时必须设置图片水印相关参数。'."\n" + ."\n" + .'默认值：自动识别水印模板类型。', + 'type' => 'string', + 'example' => 'Image', + ], + 'TemplateId' => [ + 'description' => '水印模板ID。', + 'type' => 'string', + 'example' => '962e1332fa2d4e12bdfb76dd1402fcfa', + ], + 'X' => [ + 'description' => '图片水印相对输出视频的水平偏移量。如设置则覆盖指定水印模板中的对应参数。有两种设置方式：'."\n" + .'- 整数型，代表偏移像素。'."\n" + .' - 单位：px。'."\n" + .' - 值范围：[8,4096]。'."\n" + .'- 小数型，代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 值范围：(0,1)。'."\n" + .' - 支持4位小数，如0.9999，超出部分自动丢弃。', + 'type' => 'string', + 'example' => '0.08', + ], + 'Y' => [ + 'description' => '图片水印相对输出视频的垂直偏移量。如设置则覆盖指定水印模板中的对应参数。有两种设置方式：'."\n" + .'- 整数型，代表偏移像素。'."\n" + .' - 单位：px。'."\n" + .' - 值范围：[8,4096]。'."\n" + .'- 小数型，代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 值范围：(0,1)。'."\n" + .' - 支持4位小数，如0.9999，超出部分自动丢弃。', + 'type' => 'string', + 'example' => '0.08', + ], + 'Width' => [ + 'description' => '图片水印宽度。如设置则覆盖指定水印模板中的对应参数。有两种设置方式：'."\n" + .'- 整数型，代表偏移像素。'."\n" + .' - 单位：px。'."\n" + .' - 值范围：[8,4096]。'."\n" + .'- 小数型，代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 值范围：(0,1)。'."\n" + .' - 支持4位小数，如0.9999，超出部分自动丢弃。', + 'type' => 'string', + 'example' => '0.1', + ], + 'Height' => [ + 'description' => '图片水印高度。如设置则覆盖指定水印模板中的对应参数。有两种设置方式：'."\n" + .'- 整数型，代表偏移像素。'."\n" + .' - 单位：px。'."\n" + .' - 值范围：[8,4096]。'."\n" + .'- 小数型，代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 值范围：(0,1)。'."\n" + .' - 支持4位小数，如0.9999，超出部分自动丢弃。', + 'type' => 'string', + 'example' => '0.1', + ], + 'Content' => [ + 'description' => '文字水印内容。', + 'type' => 'string', + 'example' => 'TextWatarmark', + ], + 'FontName' => [ + 'description' => '文字水印的字体名称。'."\n" + .'- 默认值：SimSum。', + 'type' => 'string', + 'example' => 'SimSum', + ], + 'FontSize' => [ + 'description' => '文字水印字号。'."\n" + .'- 值范围：(4,120)。'."\n" + .'- 默认值：16。', + 'type' => 'string', + ], + 'FontColor' => [ + 'description' => '文字水印字体颜色。'."\n" + .'- 默认值：black。', + 'type' => 'string', + 'example' => 'black', + ], + 'FontAlpha' => [ + 'description' => '字体透明度。'."\n" + .'- 值范围：(0,1]。'."\n" + .'- 默认值：1.0。', + 'type' => 'string', + 'example' => '1.0', + ], + 'BorderWidth' => [ + 'description' => '文字水印描边宽度。'."\n" + .'- 单位：px。'."\n" + .'- 值范围：[0,4096]。'."\n" + .'- 默认值：0。', + 'type' => 'string', + 'example' => '0', + ], + 'BorderColor' => [ + 'description' => '文字水印描边颜色。'."\n" + .'- 默认值：Black。', + 'type' => 'string', + 'example' => 'Black', + ], + 'Adaptive' => [ + 'description' => '文字水印字号是否适配输出视频大小。'."\n" + .'- true：是'."\n" + .'- false：否'."\n" + .'- 默认值：false', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'Metadata' => [ + 'description' => '用于指定输出视频封装格式的metadata，格式为JSON键值对，示例: {"key1":"value1","key2":"value2"}。'."\n" + .'- key最大长度为64。'."\n" + .'- value最大长度为512。'."\n" + ."\n" + .'最多支持添加4个metadata键值对。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '向量数据的元信息，为MAP格式的JSON字符串。其中key代表字段名，value代表数据类型。', + 'type' => 'string', + 'example' => '{"AIGC": "xxx"}', + ], + ], + ], + ], + 'MediaConvertJobOverwiteParams' => [ + 'description' => '转码覆盖参数设置。', + 'type' => 'object', + 'properties' => [ + 'Subtitles' => [ + 'description' => '字幕流配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕流配置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '字幕编码格式。', + 'type' => 'string', + 'example' => 'VTT', + ], + ], + ], + ], + ], + ], + 'MediaConvertJobWithoutDetail' => [ + 'description' => '没有Detail 信息的 MediaConvertJob 结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '创建转码作业的请求ID', + 'description' => '创建转码作业的请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Message' => [ + 'title' => '作业失败详细信息', + 'description' => '作业失败详细信息', + 'type' => 'string', + 'example' => 'The resource operated "%s" cannot be found', + ], + 'FinishTime' => [ + 'description' => '任务结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T13:01:07Z', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '{"info": "xxx"}', + ], + 'Config' => [ + 'title' => '转码作业配置', + 'description' => '转码作业配置', + 'type' => 'object', + 'properties' => [ + 'Outputs' => [ + 'title' => '转码作业输出配置列表', + 'description' => '转码作业输出配置列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输出配置', + 'description' => '转码作业输出配置', + '$ref' => '#/components/schemas/MediaConvertOutput', + ], + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'Name', + ], + 'OutputGroups' => [ + 'title' => '转码作业输出组列表', + 'description' => '转码作业输出组列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输出组配置', + 'description' => '转码作业输出组配置', + '$ref' => '#/components/schemas/MediaConvertOutputGroup', + ], + ], + 'Inputs' => [ + 'title' => '转码作业输入列表', + 'description' => '转码作业输入列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输入', + 'description' => '转码作业输入', + '$ref' => '#/components/schemas/MediaConvertInput', + ], + ], + ], + ], + 'State' => [ + 'title' => '转码作业状态。'."\n" + .'● Inited : 初始化；'."\n" + .'● Running : 运行中；'."\n" + .'● Success : 转码成功；'."\n" + .'● Failed : 转码失败；'."\n" + .'● Cancelled : 已取消'."\n", + 'description' => '转码作业状态。'."\n" + .'- Inited : 初始化；'."\n" + .'- Running : 运行中；'."\n" + .'- Complete : 转码完成；'."\n" + .'- Error : 转码错误；'."\n" + .'- Cancelled : 已取消', + 'type' => 'string', + 'example' => 'Inited', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T13:01:07Z'."\n", + ], + 'PipelineId' => [ + 'title' => '管道ID', + 'description' => '管道ID', + 'type' => 'string', + 'example' => '688c2a8bfa4e44ddbba0c8730db91b0c', + ], + 'ClientToken' => [ + 'title' => '创建转码作业请求的幂等参数', + 'description' => '创建转码作业请求的幂等参数', + 'type' => 'string', + 'example' => '****12e8864746a0a398****', + ], + 'Code' => [ + 'title' => '作业失败码', + 'description' => '作业失败码', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'JobId' => [ + 'title' => '转码作业 ID', + 'description' => '转码作业 ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'MediaConvertMuxConfig' => [ + 'description' => '打包配置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'description' => '分片配置字段。更多信息请参见Segment详情。'."\n" + ."\n" + .'仅当Container为m3u8、hls-fmp4、mpd、cmaf时生效。', + '$ref' => '#/components/schemas/MediaConvertSegment', + ], + ], + ], + 'MediaConvertOutput' => [ + 'title' => '转码输出配置', + 'description' => '转码输出配置', + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'title' => '转码输出文件', + 'description' => '转码输出文件', + '$ref' => '#/components/schemas/MediaObject', + ], + 'Priority' => [ + 'title' => '优先级，1-10，值越大，优先级越高，默认6', + 'description' => '优先级，1-10，值越大，优先级越高，默认6', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '10', + 'minimum' => '1', + 'example' => '6', + ], + 'OverrideParams' => [ + 'description' => '覆盖参数（JSON字符串），支持对转码模板关联的参数覆盖。', + 'type' => 'string', + 'example' => '{}', + ], + 'Features' => [ + 'description' => '功能参数。', + 'type' => 'string', + 'example' => '{}', + ], + 'TemplateId' => [ + 'title' => '转码模板ID', + 'description' => '转码模板ID', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + 'Name' => [ + 'title' => '转码输出名称', + 'description' => '转码输出名称', + 'type' => 'string', + 'example' => 'output-video', + ], + ], + ], + 'MediaConvertOutputDetail' => [ + 'description' => 'MediaConvert输出详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '任务状态'."\n", + 'description' => '任务状态:'."\n" + .'- Init: 初始化；'."\n" + .'- Scheduled: 已调度；'."\n" + .'- Success: 成功；'."\n" + .'- Failed: 失败；'."\n" + .'- Skipped: 已跳过。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TaskId' => [ + 'title' => '转码输出任务ID', + 'description' => '转码输出任务ID。', + 'type' => 'string', + 'example' => '******4215e042b3966ca5441e******', + ], + 'Message' => [ + 'title' => '转码失败详细原因', + 'description' => '转码失败详细原因。', + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad'."\n", + ], + 'FinishTime' => [ + 'description' => '输出结束时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T13:01:07Z', + ], + 'CreateTime' => [ + 'description' => '输出创建时间，格式为<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T06:06:58Z', + ], + 'Code' => [ + 'title' => '转码失败错误码', + 'description' => '转码失败错误码。', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad'."\n", + ], + 'Name' => [ + 'title' => '转码输出名称', + 'description' => '转码输出名称。', + 'type' => 'string', + 'example' => '720P-mp4', + ], + 'Result' => [ + 'description' => '输出结果详情。', + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'description' => '输出文件详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体对象类型。 取值：'."\n" + .'- OSS：OSS 文件；'."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为 OSS 时，URL 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4'."\n", + ], + 'Url' => [ + 'description' => 'Type 为 Media 时，用来说明真实文件地址。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'OutFileMeta' => [ + 'description' => '音视频流元信息。', + '$ref' => '#/components/schemas/MediaConvertOutputDetailFileMeta', + ], + ], + ], + ], + ], + 'MediaConvertOutputDetailFileMeta' => [ + 'description' => '音视频文件元信息。', + 'type' => 'object', + 'properties' => [ + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息', + 'type' => 'array', + 'items' => [ + 'description' => '视频流元信息。', + 'type' => 'object', + 'properties' => [ + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位: 秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息', + 'type' => 'array', + 'items' => [ + 'description' => '音频流元信息。', + 'type' => 'object', + 'properties' => [ + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位: 秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位: Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + ], + ], + ], + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息', + 'type' => 'object', + 'properties' => [ + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资 ID。', + 'type' => 'string', + 'example' => '9066406c306771f0bfa35107e0c90102', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。取值: source_file, transcode_file', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位: 秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '31737', + ], + ], + ], + ], + ], + 'MediaConvertOutputGroup' => [ + 'description' => '输出组设置。', + 'type' => 'object', + 'properties' => [ + 'GroupConfig' => [ + 'title' => '输出组配置', + 'description' => '输出组配置', + '$ref' => '#/components/schemas/MediaConvertOutputGroupConfig', + ], + 'Outputs' => [ + 'title' => '输出组转码配置，数组每个配置表示一个输出流', + 'description' => '输出组转码配置，数组每个配置表示一个输出流', + 'type' => 'array', + 'items' => [ + 'description' => '输出列表设置。', + '$ref' => '#/components/schemas/MediaConvertOutputGroupOutput', + ], + ], + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称', + 'type' => 'string', + 'example' => 'hls-group', + ], + ], + ], + 'MediaConvertOutputGroupConfig' => [ + 'title' => '转码输出组配置', + 'description' => '转码输出组配置', + 'type' => 'object', + 'properties' => [ + 'OutputFileBase' => [ + 'description' => '输出文件目录。该 OutputGroup 产生的文件都会在该目录下。', + '$ref' => '#/components/schemas/MediaObject', + ], + 'ManifestName' => [ + 'title' => '清单名称', + 'description' => '清单文件名称。当 Type Hls 或 Dash 时，用来指定生成的 manifest 文件的文件名。', + 'type' => 'string', + 'example' => 'manifest', + ], + 'Type' => [ + 'title' => '输出组类型，支持:'."\n" + .'● File: 表示独立的文件'."\n" + .'● Hls: HLS协议播放文件'."\n" + .'● Dash：Dash协议播放文件', + 'description' => '输出组类型，支持:'."\n" + .'- File: 表示独立的文件'."\n" + .'- Hls: HLS协议播放文件'."\n" + .'- Dash：Dash协议播放文件', + 'type' => 'string', + 'example' => 'Hls', + ], + ], + ], + 'MediaConvertOutputGroupDetail' => [ + 'title' => '转码输出组结果', + 'description' => '转码输出组结果', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '输出组状态', + 'description' => '输出组状态。'."\n" + .'- Init 已提交'."\n" + .'- Running 执行中'."\n" + .'- Success 成功'."\n" + .'- Failed 失败'."\n" + .'- Skipped 已跳过', + 'type' => 'string', + 'example' => 'Success', + ], + 'TaskId' => [ + 'title' => '转码组任务ID', + 'description' => '转码组任务ID', + 'type' => 'string', + 'example' => '******22dad741d086a50325f9******', + ], + 'Message' => [ + 'title' => '转码组失败详细信息', + 'description' => '转码组失败详细信息', + 'type' => 'string', + 'example' => 'The resource operated "InputFile" is bad', + ], + 'FinishTime' => [ + 'description' => '任务的结束时间。', + 'type' => 'string', + 'example' => '2025-03-21T01:48:41Z'."\n", + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-21T01:48:41Z', + ], + 'Outputs' => [ + 'description' => '输出详情。', + 'type' => 'array', + 'items' => [ + 'description' => '输出详情。', + '$ref' => '#/components/schemas/MediaConvertOutputDetail', + ], + ], + 'Code' => [ + 'title' => '转码组失败code', + 'description' => '转码组失败code', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad', + ], + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称', + 'type' => 'string', + 'example' => 'hls-group', + ], + ], + ], + 'MediaConvertOutputGroupOutput' => [ + 'description' => '转码组转码输出配置。', + 'type' => 'object', + 'properties' => [ + 'Priority' => [ + 'description' => '优先级，1-10，值越大，优先级越高，默认6', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'OverrideParams' => [ + 'description' => '覆盖参数（JSON字符串），支持对转码模板关联的参数覆盖。', + 'type' => 'string', + 'example' => '{}', + ], + 'Features' => [ + 'description' => '功能参数。', + 'type' => 'string', + 'example' => '{}', + ], + 'OutputFileName' => [ + 'description' => '转码输出文件名。配合 MediaConvertOutputGroupConfig 中 OutputFileBase 一起使用。', + 'type' => 'string', + 'example' => '720p.mp4', + ], + 'TemplateId' => [ + 'description' => '转码模板ID', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****'."\n", + ], + 'Name' => [ + 'description' => '转码输出名称，仅用于标记输出。', + 'type' => 'string', + 'example' => 'group-output', + ], + ], + ], + 'MediaConvertSegment' => [ + 'title' => '视频转码切片配置', + 'description' => '视频转码切片配置', + 'type' => 'object', + 'properties' => [ + 'ForceSegTime' => [ + 'title' => '指定分片时间点列表。时间点之间逗号分隔，最多指定10个。'."\n" + .'● 格式：{时间点},{时间点},{时间点}。'."\n" + .'● 时间点格式：小数型，最多3位小数。'."\n" + .'● 时间点单位：秒。'."\n" + .'● 示例：1,2,4,6,10,14,18，代表在第1、2、4、6、10、14、18秒处强制分片。', + 'description' => '指定分片时间点列表。时间点之间逗号分隔，最多指定10个。'."\n" + .'- 格式：{时间点},{时间点},{时间点}。'."\n" + .'- 时间点格式：小数型，最多3位小数。'."\n" + .'- 时间点单位：秒。'."\n" + .'- 示例：1,2,4,6,10,14,18，代表在第1、2、4、6、10、14、18秒处强制分片。', + 'type' => 'string', + 'example' => '1,2', + ], + 'Duration' => [ + 'title' => '分片时长。'."\n" + .'● 单位：秒。'."\n" + .'● 值范围：[1,60]。'."\n" + .'● 默认值：10。代表在第10、20、30、40秒处强制分片。', + 'description' => '分片时长。'."\n" + .'- 单位：秒。'."\n" + .'- 值范围：[1,60]。'."\n" + .'- 默认值：10。代表在第10、20、30、40秒处强制分片。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'MediaConvertTransConfig' => [ + 'title' => '转码配置', + 'description' => '转码配置', + 'type' => 'object', + 'properties' => [ + 'IsCheckAudioBitrate' => [ + 'title' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + .'● true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：'."\n" + .' ○ 参数为空，并且codec和输入源不一样：false。'."\n" + .' ○ 参数为空，并且codec和输入源一样：true。', + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：'."\n" + .' - 参数为空，并且codec和输入源不一样：false。'."\n" + .' - 参数为空，并且codec和输入源一样：true。', + 'type' => 'boolean', + ], + 'AdjDarMethod' => [ + 'title' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + .'● 可选值：rescale、crop、pad、none。'."\n" + .'● 默认值：none。'."\n" + .'● 示例：请参见如何设置分辨率。', + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + .'- 可选值：rescale、crop、pad、none。'."\n" + .'- 默认值：none。'."\n" + .'- 示例：请参见如何设置分辨率。', + 'type' => 'string', + 'example' => 'rescale', + ], + 'IsCheckAudioBitrateFail' => [ + 'title' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'● true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：false。', + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + 'IsCheckVideoBitrateFail' => [ + 'title' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'● true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：false。', + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + 'IsCheckReso' => [ + 'title' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + .'● true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：false。', + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + 'IsCheckVideoBitrate' => [ + 'title' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + .'● true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：false。', + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + 'TransMode' => [ + 'title' => '视频转码模式。仅Codec为H.264、H.265、AV1时生效，且不同模式必须搭配Video的Bitrate、Crf正确设置。详细说明请参见下文视频码率控制模式。取值如下：'."\n" + .'● CBR：固定码率模式。'."\n" + .'● onepass：一般用于ABR。编码速度较twopass更快。'."\n" + .'● twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + .'● fixCRF：Crf质量控制模式。'."\n" + .'● 默认值：有Bitrate为onepass。没有Bitrate为fixCRF，Crf使用默认值。', + 'description' => '视频转码模式。仅Codec为H.264、H.265、AV1时生效，且不同模式必须搭配Video的Bitrate、Crf正确设置。详细说明请参见下文视频码率控制模式。取值如下：'."\n" + .'- CBR：固定码率模式。'."\n" + .'- onepass：一般用于ABR。编码速度较twopass更快。'."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + .'- fixCRF：Crf质量控制模式。'."\n" + .'- 默认值：有Bitrate为onepass。没有Bitrate为fixCRF，Crf使用默认值。', + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckResoFail' => [ + 'title' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + .'● true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + .'● false：不检查。'."\n" + .'● 默认值：false。', + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + .'- false：不检查。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + ], + ], + ], + 'MediaConvertVideo' => [ + 'title' => '转码视频流配置', + 'description' => '转码视频流配置', + 'type' => 'object', + 'properties' => [ + 'Bufsize' => [ + 'title' => '码率控制缓冲区大小。用于控制码率波动。详细说明请参见视频码率控制模式。'."\n" + .'说明'."\n" + .'Bufsize值越大，码率的波动越大，视频质量越高。'."\n" + .'● 单位：Kb。'."\n" + .'● 值范围：[1000,128000]。'."\n" + .'● 默认值：6000。', + 'description' => '码率控制缓冲区大小。用于控制码率波动。详细说明请参见视频码率控制模式。'."\n" + .'说明'."\n" + .'Bufsize值越大，码率的波动越大，视频质量越高。'."\n" + .'- 单位：Kb。'."\n" + .'- 值范围：[1000,128000]。'."\n" + .'- 默认值：6000。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'Qscale' => [ + 'title' => '视频质量控制值（VBR模式可用）。'."\n" + .'说明'."\n" + .'Qscale值越大，视频质量越低，压缩率越高。'."\n" + .'● 仅Codec为H.264时生效。'."\n" + .'● 值范围：[0,51]。', + 'description' => '视频质量控制值（VBR模式可用）。'."\n" + .'说明'."\n" + .'Qscale值越大，视频质量越低，压缩率越高。'."\n" + .'- 仅Codec为H.264时生效。'."\n" + .'- 值范围：[0,51]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'ScanMode' => [ + 'title' => '扫描模式。取值如下：'."\n" + .'● 不设置：按输入文件的原始模式。'."\n" + .'● auto：自动去隔行。'."\n" + .'● progressive：顺序扫描（逐行扫描）。'."\n" + .'● interlaced：交叉扫描（隔行扫描）。'."\n" + .'● 默认值：空，即不设置。'."\n" + .'最佳实践：交叉扫描虽然比顺序扫描更节省数据量，但画质不佳，所以现在主流视频制作都采用顺序扫描。'."\n" + .'● 如果您设置了顺序扫描或交叉扫描，但与原视频模式不符，会导致转码失败。'."\n" + .'● 建议您设置原视频模式或自动去隔行，以提高兼容性。', + 'description' => '扫描模式。取值如下：'."\n" + .'- 不设置：按输入文件的原始模式。'."\n" + .'- auto：自动去隔行。'."\n" + .'- progressive：顺序扫描（逐行扫描）。'."\n" + .'- interlaced：交叉扫描（隔行扫描）。'."\n" + .'- 默认值：空，即不设置。'."\n" + ."\n" + .'最佳实践：交叉扫描虽然比顺序扫描更节省数据量，但画质不佳，所以现在主流视频制作都采用顺序扫描。'."\n" + .'- 如果您设置了顺序扫描或交叉扫描，但与原视频模式不符，会导致转码失败。'."\n" + .'- 建议您设置原视频模式或自动去隔行，以提高兼容性。', + 'type' => 'string', + 'example' => 'auto', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（又称，长短边自适应）。当Width或Height至少填写一项时生效。'."\n" + .'● true：开启。'."\n" + .'● false：关闭。'."\n" + .'● 默认值：false。'."\n" + .'● 最佳实践：如果您的输入视频既有横屏视频也有竖屏视频，为了避免视频拉伸变形，请开启横竖屏自适应开关，并结合分辨率参数设置等比缩放。示例请参见设置横竖屏自适应。', + 'description' => '是否开启横竖屏自适应（又称，长短边自适应）。当Width或Height至少填写一项时生效。'."\n" + .'- true：开启。'."\n" + .'- false：关闭。'."\n" + .'- 默认值：false。'."\n" + ."\n" + .'最佳实践：如果您的输入视频既有横屏视频也有竖屏视频，为了避免视频拉伸变形，请开启横竖屏自适应开关，并结合分辨率参数设置等比缩放。示例请参见设置横竖屏自适应。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .'● 单位：fps，帧每秒。'."\n" + .'● 值范围：(0,60]。'."\n" + .'● 默认值：输入文件的视频原始帧率，超过60时取60。'."\n" + .'● 常见值：24、25、30。', + 'description' => '帧率。'."\n" + .'- 单位：fps，帧每秒。'."\n" + .'- 值范围：(0,60]。'."\n" + .'- 默认值：输入文件的视频原始帧率，超过60时取60。'."\n" + .'- 常见值：24、25、30。', + 'type' => 'any', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '设置相邻两个I帧之间的时间或者帧数间隔。'."\n" + .'● 关键帧间最大时间间隔：{时间}s，时间范围[1,100000]。'."\n" + .'● 关键帧间最大帧数间隔：{帧数}，帧数范围[1,100000]。'."\n" + .'● 默认值：10s，代表每10s一个关键帧。'."\n" + .'● 最佳实践：流媒体播放场景下，为了提高播放器开播速度和seek响应时长，建议设置为[2,7]s。', + 'description' => '设置相邻两个I帧之间的时间或者帧数间隔。'."\n" + .'- 关键帧间最大时间间隔：{时间}s，时间范围[1,100000]。'."\n" + .'- 关键帧间最大帧数间隔：{帧数}，帧数范围[1,100000]。'."\n" + .'- 默认值：10s，代表每10s一个关键帧。'."\n" + ."\n" + .' 最佳实践：流媒体播放场景下，为了提高播放器开播速度和seek响应时长，建议设置为[2,7]s。', + 'type' => 'any', + 'example' => '10s', + ], + 'Remove' => [ + 'title' => '是否删除视频流。'."\n" + .'● true：删除。则本节所有Video相关参数失效。'."\n" + .'● false：保留。'."\n" + .'● 默认值：false。', + 'description' => '是否删除视频流。'."\n" + .'- true：删除。则本节所有Video相关参数失效。'."\n" + .'- false：保留。'."\n" + .'- 默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Bitrate' => [ + 'title' => '输出文件的视频平均码率。使用CBR、ABR、VBR码控必须设置Bitrate，且TransMode需正确配对设置。详细说明请参见视频码率控制模式。'."\n" + .'● 单位：Kbps。'."\n" + .'● 值范围：-1、[10,50000]。-1代表使用输入视频的原始码率。'."\n" + .'● 最佳实践：'."\n" + .' ○ CBR固定码率模式：需设置TransMode为CBR，且Bitrate=Maxrate=Bufsize。'."\n" + .' ○ ABR平均码率模式：需设置TransMode为onepass，且指定Bitrate。还可指定Maxrate和Bufsize控制码率波动范围。'."\n" + .' ○ VBR动态码率模式：需设置TransMode为twopass，且指定Maxrate（或BitrateBnd）和Bufsize参数。', + 'description' => '输出文件的视频平均码率。使用CBR、ABR、VBR码控必须设置Bitrate，且TransMode需正确配对设置。详细说明请参见视频码率控制模式。'."\n" + .'- 单位：Kbps。'."\n" + .'- 值范围：-1、[10,50000]。-1代表使用输入视频的原始码率。'."\n" + ."\n" + .' 最佳实践：'."\n" + .' - CBR固定码率模式：需设置TransMode为CBR，且Bitrate=Maxrate=Bufsize。'."\n" + .' - ABR平均码率模式：需设置TransMode为onepass，且指定Bitrate。还可指定Maxrate和Bufsize控制码率波动范围。'."\n" + .' - VBR动态码率模式：需设置TransMode为twopass，且指定Maxrate（或BitrateBnd）和Bufsize参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000', + ], + 'Profile' => [ + 'title' => '编码级别。更多信息请参见基本概念。'."\n" + .'● 仅Codec为H.264时生效。'."\n" + .'● 可选值：baseline、main、high。'."\n" + .'● 默认值：high。'."\n" + .'● 最佳实践：一个视频输出多清晰度时，建议最低清晰度设置baseline，以保证最低端设备可播放。其他清晰度设置为main或high。', + 'description' => '编码级别。更多信息请参见基本概念。'."\n" + .'- 仅Codec为H.264时生效。'."\n" + .'- 可选值：baseline、main、high。'."\n" + .'- 默认值：high。'."\n" + ."\n" + .' 最佳实践：一个视频输出多清晰度时，建议最低清晰度设置baseline，以保证最低端设备可播放。其他清晰度设置为main或high。', + 'type' => 'string', + 'example' => 'high', + ], + 'Crop' => [ + 'title' => '视频画面剪裁。支持自动去黑边或自定义剪裁。'."\n" + .'● 请在输入视频分辨率大于输出视频分辨率时使用。不要设置分辨率改写参数AdjDarMethod。'."\n" + .'● 自动去黑边：border。'."\n" + .'● 自定义剪裁：参数格式为{width}:{height}:{left}:{top}。'."\n" + .' ○ width：剪裁后，输出视频的宽度。'."\n" + .' ○ height：剪裁后，输出视频的高度。'."\n" + .' ○ left：输出画面距离原画面的左边距。'."\n" + .' ○ top：输出画面距离原画面的上边距。'."\n" + .'● 自定义剪裁示例：1920:800:0:140。', + 'description' => '视频画面剪裁。支持自动去黑边或自定义剪裁。'."\n" + .'- 请在输入视频分辨率大于输出视频分辨率时使用。不要设置分辨率改写参数AdjDarMethod。'."\n" + .'- 自动去黑边：border。'."\n" + .'- 自定义剪裁：参数格式为{width}:{height}:{left}:{top}。'."\n" + .' - width：剪裁后，输出视频的宽度。'."\n" + .' - height：剪裁后，输出视频的高度。'."\n" + .' - left：输出画面距离原画面的左边距。'."\n" + .' - top：输出画面距离原画面的上边距。'."\n" + ."\n" + .' 自定义剪裁示例：1920:800:0:140。', + 'type' => 'string', + 'example' => '1920:800:0:140', + ], + 'Codec' => [ + 'title' => '视频编码格式。'."\n" + .'● 可选值：H.264、H.265、AV1、GIF、WEBP。更多格式和与Container的兼容要求，请参见格式支持。'."\n" + .'● 默认值：H.264。', + 'description' => '视频编码格式。'."\n" + .'- 可选值：H.264、H.265、AV1、GIF、WEBP。更多格式和与Container的兼容要求，请参见格式支持。'."\n" + .'- 默认值：H.264。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Maxrate' => [ + 'title' => '输出文件的视频码率峰值。详细说明请参见视频码率控制模式。'."\n" + .'● 单位：Kbps。'."\n" + .'● 值范围：[10,50000]。', + 'description' => '输出文件的视频码率峰值。详细说明请参见视频码率控制模式。'."\n" + .'- 单位：Kbps。'."\n" + .'- 值范围：[10,50000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Pad' => [ + 'title' => '视频贴黑边。'."\n" + .'● 请在输入视频分辨率小于输出视频分辨率时使用。不要设置分辨率检查参数IsCheckReso和IsCheckResoFail、不要设置分辨率改写参数AdjDarMethod。'."\n" + .'● 参数格式：{width}:{height}:{left}:{top}。'."\n" + .' ○ width：贴黑边后，输出视频的宽度。'."\n" + .' ○ height：贴黑边后，输出视频的高度。'."\n" + .' ○ left：原画面距离输出画面的左边距。'."\n" + .' ○ top：原画面距离输出画面的上边距。'."\n" + .'● 示例：1920:1080:0:140。', + 'description' => '视频贴黑边。'."\n" + .'- 请在输入视频分辨率小于输出视频分辨率时使用。不要设置分辨率检查参数IsCheckReso和IsCheckResoFail、不要设置分辨率改写参数AdjDarMethod。'."\n" + .'- 参数格式：{width}:{height}:{left}:{top}。'."\n" + .' - width：贴黑边后，输出视频的宽度。'."\n" + .' - height：贴黑边后，输出视频的高度。'."\n" + .' - left：原画面距离输出画面的左边距。'."\n" + .' - top：原画面距离输出画面的上边距。'."\n" + ."\n" + .' 示例：1920:1080:0:140。', + 'type' => 'string', + 'example' => '1920:1080:0:140', + ], + 'MaxFps' => [ + 'title' => '最大帧率。', + 'description' => '最大帧率。', + 'type' => 'any', + 'example' => '25', + ], + 'Crf' => [ + 'title' => '质量控制因子。使用Crf码控必须设置Crf，且TransMode需设置为fixCRF，详细说明请参见视频码率控制模式。'."\n" + .'说明'."\n" + .'Crf值越大，视频质量越低，压缩率越高。'."\n" + .'● 值范围：[20,51]。'."\n" + .'● 默认值：Codec为H.264时，默认值为23；Codec为H.265时，默认值为26；Codec为AV1时，默认值为32。'."\n" + .'● 最佳实践：'."\n" + .' ○ 0为无损，51为最差。建议取值[23,29]。您可根据画面复杂度进行调节。每增加或减少6，码率会减少一半或增加一倍，通常同等清晰度下动画片可以比实拍设置得更高。'."\n" + .' ○ Crf以质量为目标，输出视频码率不可预知，可结合Maxrate、Bufsize来控制码率波动范围。', + 'description' => '质量控制因子。使用Crf码控必须设置Crf，且TransMode需设置为fixCRF，详细说明请参见视频码率控制模式。'."\n" + .'说明'."\n" + .'Crf值越大，视频质量越低，压缩率越高。'."\n" + .'- 值范围：[20,51]。'."\n" + .'- 默认值：Codec为H.264时，默认值为23；Codec为H.265时，默认值为26；Codec为AV1时，默认值为32。'."\n" + ."\n" + .' 最佳实践：'."\n" + .' - 0为无损，51为最差。建议取值[23,29]。您可根据画面复杂度进行调节。每增加或减少6，码率会减少一半或增加一倍，通常同等清晰度下动画片可以比实拍设置得更高。'."\n" + .' - Crf以质量为目标，输出视频码率不可预知，可结合Maxrate、Bufsize来控制码率波动范围。', + 'type' => 'any', + 'example' => '23', + ], + 'Height' => [ + 'title' => '高度（或短边）。当LongShortMode为false或未设置时，代表视频的高度。当LongShortMode为true时，代表视频的短边。'."\n" + .'● 单位：px。'."\n" + .'● 值范围：[128,4096]，必须为偶数。'."\n" + .'● 默认值'."\n" + .' ○ 当Width和Height都未设置：使用输入视频的原始高度（或短边）。'."\n" + .' ○ 当仅设置Width：按照输入视频的原始比例计算。', + 'description' => '高度（或短边）。当LongShortMode为false或未设置时，代表视频的高度。当LongShortMode为true时，代表视频的短边。'."\n" + .'- 单位：px。'."\n" + .'- 值范围：[128,4096]，必须为偶数。'."\n" + .'- 默认值'."\n" + .' - 当Width和Height都未设置：使用输入视频的原始高度（或短边）。'."\n" + .' - 当仅设置Width：按照输入视频的原始比例计算。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'Width' => [ + 'title' => '宽度（或长边）。当LongShortMode为false或未设置时，代表宽度。当LongShortMode为true时，代表视频的长边。'."\n" + .'● 单位：px。'."\n" + .'● 值范围：[128,4096]，必须为偶数。'."\n" + .'● 默认值'."\n" + .' ○ 当Width和Height都未设置：使用输入视频的原始宽度（或长边）。'."\n" + .' ○ 当仅设置Height：按照输入视频的原始比例来计算。', + 'description' => '宽度（或长边）。当LongShortMode为false或未设置时，代表宽度。当LongShortMode为true时，代表视频的长边。'."\n" + .'- 单位：px。'."\n" + .'- 值范围：[128,4096]，必须为偶数。'."\n" + .'- 默认值'."\n" + .' - 当Width和Height都未设置：使用输入视频的原始宽度（或长边）。'."\n" + .' - 当仅设置Height：按照输入视频的原始比例来计算。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + ], + ], + 'MediaConvertVolume' => [ + 'description' => '音量调整参数对象。', + 'type' => 'object', + 'properties' => [ + 'LoudnessRangeTarget' => [ + 'title' => '相对目标音量的波动范围。'."\n" + .'● 当指定Method为dynamic时生效。'."\n" + .'● 单位：db。'."\n" + .'● 值范围：[1,20]。'."\n" + .'● 默认值：8。', + 'description' => '相对目标音量的波动范围。'."\n" + .'- 当指定Method为dynamic时生效。'."\n" + .'- 单位：db。'."\n" + .'- 值范围：[1,20]。'."\n" + .'- 默认值：8。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'TruePeak' => [ + 'title' => '最大峰值。'."\n" + .'● 当指定Method为dynamic时生效。'."\n" + .'● 单位：db。'."\n" + .'● 值范围：[-9,0]。'."\n" + .'● 默认值：-1。', + 'description' => '最大峰值。'."\n" + .'- 当指定Method为dynamic时生效。'."\n" + .'- 单位：db。'."\n" + .'- 值范围：[-9,0]。'."\n" + .'- 默认值：-1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量。'."\n" + .'● 当指定Method为dynamic时生效。'."\n" + .'● 单位：db。'."\n" + .'● 值范围：[-70,-5]。'."\n" + .'● 默认值：-6。', + 'description' => '目标音量。'."\n" + .'- 当指定Method为dynamic时生效。'."\n" + .'- 单位：db。'."\n" + .'- 值范围：[-70,-5]。'."\n" + .'- 默认值：-6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-6', + ], + 'Level' => [ + 'title' => '相对输入音频的音量提升的幅度。'."\n" + .'● 当指定Method为linear时生效。'."\n" + .'● 单位：db。'."\n" + .'● 值范围：不超过20db。'."\n" + .'● 默认值：-20db。', + 'description' => '相对输入音频的音量提升的幅度。'."\n" + .'- 当指定Method为linear时生效。'."\n" + .'- 单位：db。'."\n" + .'- 值范围：不超过20db。'."\n" + .'- 默认值：-20db。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-20', + ], + 'Method' => [ + 'title' => '音量调整方式。'."\n" + .'● auto：自动调整。'."\n" + .'● dynamic：动态调整。'."\n" + .'● linear：线性调整。'."\n" + .'● 默认值：dynamic。', + 'description' => '音量调整方式。'."\n" + .'- auto：自动调整。'."\n" + .'- dynamic：动态调整。'."\n" + .'- linear：线性调整。'."\n" + .'- 默认值：dynamic。', + 'type' => 'string', + 'enumValueTitles' => [ + 'adaptive' => 'adaptive', + 'auto' => 'auto', + 'linear' => 'linear', + 'dynamic' => 'dynamic', + ], + 'example' => 'linear', + ], + ], + ], + 'MediaObject' => [ + 'title' => '媒体文件', + 'description' => '媒体文件', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '输入类型，支持：'."\n" + .'- OSS: 阿里云 oss 文件 '."\n" + .'- Media: 媒资'."\n" + .'- ExternalURL： 外部URL，暂不对外支持', + 'description' => '输入类型，支持：'."\n" + .'- OSS: 阿里云 oss 文件 '."\n" + .'- Media: 媒资'."\n" + .'- ExternalURL： 外部URL，暂不对外支持', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '文件媒资'."\n" + .'- Type为OSS 时，media为URL，且支持 OSS 协议和 HTTP 协议。 '."\n" + .'- Type为Media 时，media为媒资 ID。', + 'description' => '文件媒资'."\n" + .'- Type为OSS 时，media为URL，且支持 OSS 协议和 HTTP 协议。 '."\n" + .'- Type为Media 时，media为媒资 ID。', + 'type' => 'string', + 'example' => 'http://bucket.loction.aliyuncs.com/path/to/video.mp4', + ], + ], + ], + 'MediaQualityAnalysisJob' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'JobId' => [ + 'type' => 'string', + ], + 'ScheduleConfig' => [ + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'type' => 'string', + ], + 'Priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'TemplateConfig' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'type' => 'string', + ], + ], + ], + 'State' => [ + 'type' => 'string', + ], + 'UserData' => [ + 'type' => 'string', + ], + 'Input' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'Media' => [ + 'type' => 'string', + ], + ], + ], + 'VqaResult' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaResult', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'FinishTime' => [ + 'type' => 'string', + ], + ], + ], + 'MediaQualityAnalysisJobVqaResult' => [ + 'type' => 'object', + 'properties' => [ + 'Detail' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', + ], + 'Sharp' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', + ], + 'Block' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', + ], + 'Noise' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', + ], + 'Color' => [ + '$ref' => '#/components/schemas/MediaQualityAnalysisJobVqaScoreDetail', + ], + 'State' => [ + 'type' => 'string', + ], + 'ScoreResult' => [ + 'type' => 'object', + 'properties' => [ + 'Block' => [ + 'type' => 'object', + 'properties' => [ + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Color' => [ + 'type' => 'object', + 'properties' => [ + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Detail' => [ + 'type' => 'object', + 'properties' => [ + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Noise' => [ + 'type' => 'object', + 'properties' => [ + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Sharp' => [ + 'type' => 'object', + 'properties' => [ + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Score' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + ], + ], + 'MediaQualityAnalysisJobVqaScoreDetail' => [ + 'type' => 'object', + 'properties' => [ + 'PerceptualScore' => [ + 'type' => 'number', + 'format' => 'double', + ], + 'IntensityValue' => [ + 'type' => 'number', + 'format' => 'double', + ], + ], + ], + 'Program' => [ + 'description' => '节目信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-04-02T00:58:19Z', + ], + 'ChannelName' => [ + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'AdBreaks' => [ + 'description' => '广告。', + 'type' => 'array', + 'items' => [ + 'description' => '广告', + 'type' => 'object', + 'properties' => [ + 'TimeSignalSettings' => [ + 'description' => 'TimeSignal配置。', + 'type' => 'string', + 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', + ], + 'OffsetMillis' => [ + 'description' => '偏移量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ChannelName' => [ + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'MyChannel', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'SpliceInsertSettings' => [ + 'description' => 'SpliceInsert配置。', + 'type' => 'string', + 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}', + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MyAdSource', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program_name', + ], + 'MessageType' => [ + 'description' => 'MessageType', + 'type' => 'string', + 'example' => 'SPLICE_INSERT', + ], + ], + ], + ], + 'SourceType' => [ + 'description' => '源类型。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'Transition' => [ + 'description' => '节目位置。', + 'type' => 'string', + 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2024-04-02T00:58:19Z'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'ClipRange' => [ + 'description' => '片段信息。', + 'type' => 'string', + 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}'."\n", + ], + 'Arn' => [ + 'description' => '节目资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:program/myChannel/MyProgram', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program1', + ], + ], + ], + 'ScheduleData' => [ + 'description' => '日程信息。', + 'type' => 'object', + 'properties' => [ + 'EntryType' => [ + 'description' => '日程类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'FillerSlate' => 'FillerSlate', + 'program' => 'program', + ], + 'example' => 'program', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'AdBreaks' => [ + 'description' => '广告信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OffsetMillis' => [ + 'description' => '偏移时间。', + 'type' => 'string', + 'example' => '100000', + ], + 'TimeSignalSettings' => [ + 'description' => 'TimeSignal配置。', + 'type' => 'string', + 'example' => '{"segmentationEventID":0,"segmentationUPIDType":14,"segmentationUPID":"upid","segmentationTypeID":48,"segmentNumber":0,"segmentsExpected":0,"subSegmentNumber":1,"subSegmentsExpected":0}', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'SpliceInsertSettings' => [ + 'description' => 'SpliceInsert配置。', + 'type' => 'string', + 'example' => '{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}'."\n", + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'MessageType' => [ + 'description' => 'MessageType', + 'type' => 'string', + 'example' => 'SPLICE_INSERT', + ], + ], + ], + ], + 'SourceType' => [ + 'description' => '源类型。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MySource', + ], + 'ApproximateDurationSeconds' => [ + 'description' => '预计播放时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'ApproximateStartTime' => [ + 'description' => '预计播放开始时间。', + 'type' => 'string', + 'example' => '1989128002313', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program1', + ], + ], + ], + 'Source' => [ + 'description' => '源信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-11-07T10:12:01Z', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'State' => [ + 'description' => '源状态，0表示正常，1表示删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SourceType' => [ + 'description' => '源类型。vodSource，liveSource。', + 'type' => 'string', + 'example' => 'vodSource', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-11-07T10:12:01Z', + ], + 'SourceName' => [ + 'description' => '源名称。', + 'type' => 'string', + 'example' => 'MyVodSource', + ], + 'HttpPackageConfigurations' => [ + 'description' => '源配置。', + 'type' => 'string', + 'example' => '[{'."\n" + .' "sourceGroupName": "mySourceGroup-1",'."\n" + .' "relativePath": "group1/hls.m3u8",'."\n" + .' "packageType": "hls"'."\n" + .'}]', + ], + 'Arn' => [ + 'description' => '源资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/mySource', + ], + ], + ], + 'SourceLocation' => [ + 'description' => '源位置信息。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-09-12T07:15:52Z', + ], + 'SourceLocationName' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'example' => 'MySourceLocation', + ], + 'State' => [ + 'description' => '源位置状态，0：正常，1：已删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2023-10-22T10:49:14Z', + ], + 'SegmentDeliveryConfigurations' => [ + 'description' => '切片传输配置。', + 'type' => 'string', + 'example' => 'http://segmentdelivery.com', + ], + 'BaseUrl' => [ + 'description' => '源位置Url。', + 'type' => 'string', + 'example' => 'http://xxxx.com', + ], + 'Arn' => [ + 'description' => '源位置资源描述。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<UserId>:sourcelocation/MySourceLocation', + ], + ], + ], + 'TranspositionResult' => [ + 'description' => '翻译转置结果', + 'type' => 'object', + 'properties' => [ + 'TranslatedText' => [ + 'title' => '目标转置文本', + 'description' => '- 翻译转置后的文本，即期望的命中的热词翻译后输出的结果文本，长度上限100'."\n" + .'- 该字段仅用于和翻译功能相关场景', + 'type' => 'string', + 'example' => '你好', + ], + 'TargetLanguage' => [ + 'title' => '目标转置语种', + 'description' => '- 翻译转置的目标语种，详见视频翻译目标语种列表'."\n" + .'- 该字段仅用于视频翻译功能场景', + 'type' => 'string', + 'example' => 'zh', + ], + ], + ], + 'VodPackagingAsset' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => '打包组名称。', + 'type' => 'string', + ], + 'Input' => [ + 'title' => '资产输入配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '输入类型，暂支持OSS。', + 'type' => 'string', + ], + 'Media' => [ + 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'type' => 'string', + ], + ], + ], + 'CreateTime' => [ + 'title' => '创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32。', + 'type' => 'string', + ], + 'ContentId' => [ + 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', + 'type' => 'string', + ], + 'AssetName' => [ + 'title' => 'asset名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + ], + ], + ], + 'VodPackagingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'ManifestName' => [ + 'title' => 'manifest名称，[A-Za-z0-9_]+，长度不超过128。', + 'type' => 'string', + ], + 'StreamSelection' => [ + 'title' => '打包输出流选择配置。', + 'type' => 'object', + 'properties' => [ + 'MinVideoBitsPerSecond' => [ + 'title' => '最小视频流码率，单位bps。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'StreamOrder' => [ + 'title' => '流排序规则，支持值：'."\n" + .'- ORIGINAL：保持输入序号；'."\n" + .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" + .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', + 'type' => 'string', + ], + 'MaxVideoBitsPerSecond' => [ + 'title' => '最大视频流码率，单位bps。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'DrmProvider' => [ + 'title' => 'DRM加密提供商配置。', + 'type' => 'object', + 'properties' => [ + 'SystemIds' => [ + 'title' => 'drm 系统id，system id数量由使用的协议类型决定。'."\n" + .'- DASH -- 最多两个'."\n" + .'- HLS -- 提供一个'."\n" + .'- HLS_CMAF-- 最多提供两个。'."\n" + .'只支持 Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM System，对应SystemId分别为 ：'."\n" + .'Apple FairPlay：'."\n" + .'94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" + .'Google Widevine：'."\n" + .'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" + .'Microsoft PlayReady：'."\n" + .'9a04f079-9840-4286-ab92-e65be0885f95。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'EncryptionMethod' => [ + 'title' => '加密算法，支持值：'."\n" + .'- AES_128'."\n" + .'- SAMPLE_AES', + 'type' => 'string', + ], + 'IV' => [ + 'title' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', + 'type' => 'string', + ], + 'Url' => [ + 'title' => 'DRM key提供商url。', + 'type' => 'string', + ], + ], + ], + 'SegmentDuration' => [ + 'title' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'VodPackagingConfiguration' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => '打包组名称，长度128个字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '打包配置描述信息。', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '创建时间。', + 'type' => 'string', + ], + 'ConfigurationName' => [ + 'title' => '打包配置名称，长度128个字符，格式：[A-Za-z0-9_-]+，用户维度唯一。', + 'type' => 'string', + ], + 'Protocol' => [ + 'title' => '打包类型，支持：'."\n" + .'- HLS: HLC协议播放格式；'."\n" + .'- HLS_CMAF： HLS协议的CMAF播放格式；'."\n" + .'- DASH: DASH协议播放格式。', + 'type' => 'string', + ], + 'PackageConfig' => [ + '$ref' => '#/components/schemas/VodPackagingConfig', + ], + ], + ], + 'VodPackagingGroup' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '打包组描述信息。', + 'type' => 'string', + ], + 'DomainName' => [ + 'title' => '打包组播放域名，同一个打包组所有点播打包资产域名相同。', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '打包组创建时间。', + 'type' => 'string', + ], + 'ApproximateAssetCount' => [ + 'title' => '打包组中打包资产数量近似值。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ConfigurationCount' => [ + 'title' => '打包组中打包配置数量。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateUploadMedia' => [ + 'summary' => '本接口支持获取音视频、图片和辅助媒资的上传地址和凭证。并创建媒资信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。默认取值：app-1000000。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID。可调用CreateEntity接口创建实体，自定义动态元数据结构。', + 'type' => 'string', + 'required' => false, + 'example' => '9e177cac2fb44f8b8c67b199fcc7bffd', + ], + ], + [ + 'name' => 'FileInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '文件信息，JSON类型，包含参数字段：'."\n" + .'- Type（必填）：文件类型，取值video、image、audio、text、other。'."\n" + .'- Name（必填）：文件名，不带扩展名。'."\n" + .'- Size（选填）：文件大小。'."\n" + .'- Ext（必填）：文件扩展名。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Type\\":\\"video\\",\\"Name\\":\\"test\\",\\"Size\\":108078336,\\"Ext\\":\\"mp4\\"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调等设置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}', + ], + ], + [ + 'name' => 'UploadTargetConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '目标存储地址。'."\n" + ."\n" + .'- StorageType 取值：仅支持oss。'."\n" + .'- StorageLocation 仅支持VOD点播存储，不支持用户自有OSS存储。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"StorageType\\":\\"oss\\",\\"StorageLocation\\":\\"outin-***.oss-cn-shanghai.aliyuncs.com\\"}', + ], + ], + [ + 'name' => 'MediaMetaData', + 'in' => 'query', + 'schema' => [ + 'description' => '上传媒资的元数据，JSON格式。'."\n" + ."\n" + .'Title 标题（必填）：'."\n" + .'- 长度不超过128个字符。'."\n" + .'- UTF-8编码。'."\n" + ."\n" + .'Description 描述（选填）：'."\n" + .'- 长度不超过1024个字符。'."\n" + .'- UTF-8编码。'."\n" + ."\n" + .'CateId 分类ID（选填）。'."\n" + ."\n" + .'Tags 标签（选填）。'."\n" + ."\n" + .'BusinessType 业务类型（必填），取值：'."\n" + .'- Type = video ，取值：'."\n" + .'opening： 片头/开场；ending： 片尾'."\n" + .'- Type = image ，取值：'."\n" + .' default：默认；'."\n" + .' cover：封面'."\n" + .'- Type = text ，取值：'."\n" + .' subtitles：字幕；'."\n" + .' font：字体；'."\n" + .'- Type=material ，取值：'."\n" + .' watermark：水印；'."\n" + .'- general 通用；'."\n" + .'CoverURL 封面（选填）。'."\n" + ."\n" + .'DynamicMetaData 动态元数据，类型为字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Title\\": \\"UploadTest\\", \\"Description\\": \\"UploadImageTest\\", \\"Tags\\": \\"tag1,tag2\\",\\"BusinessType\\":\\"cover\\"}', + ], + ], + [ + 'name' => 'PostProcessConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Type = video || audio 有上传后处理动作。'."\n" + ."\n" + .'ProcessType取值：Workflow。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"ProcessType\\":\\"Workflow\\",\\"ProcessID\\":\\"74ba870f1a4873a3ba238e0bf6fa9***\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'MediaURL' => [ + 'description' => '媒资地址。'."\n" + .'> 如果配置了CDN域名则返回CDN地址，否则为OSS地址。说明如果返回的MediaURL在浏览器无法访问（403），是因为您开启了点播域名的鉴权功能。可关闭URL鉴权或自助生成鉴权签名。'."\n", + 'type' => 'string', + 'example' => 'https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4', + ], + 'FileURL' => [ + 'description' => '文件OSS地址（不带鉴权）。', + 'type' => 'string', + 'example' => 'http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + .'>接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + ."\n" + .'> 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'eyJFbmRwb2ludCI6Imm****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaURL\\": \\"https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', + 'title' => '获取媒资上传地址和凭证', + 'description' => '### 接口说明'."\n" + .'- 获取上传地址和凭证为智能媒体服务的核心基础，是每个上传操作的必经过程。'."\n" + .'- 如果视频上传凭证失效（默认有效期为3000秒），请调用刷新视频上传凭证接口重新获取上传凭证。'."\n" + .'- 上传后，可通过配置回调，接收上传事件通知或调用GetMediaInfo接口根据返回的媒资状态来判断是否上传成功。'."\n" + .'- 本接口返回的MediaId参数，可以用于媒资生命周期管理或媒体处理。'."\n" + .'### 使用限制'."\n" + .'- 本接口仅支持上传至VOD点播存储，不支持上传至用户自有OSS存储。使用自有OSS存储的用户，可以先通过[OSS SDK](~~32006~~)上传文件至OSS，再调用[RegisterMediaInfo](~~441152~~)接口将OSS文件注册至媒资库。'."\n" + .'- 本接口目前仅支持华东2（上海）、华北2（北京）、华南1（深圳）地域。', + ], + 'CreateUploadStream' => [ + 'summary' => '获取媒体流上传地址和凭证，并将上传完成的媒体流挂载到指定的MediaId下。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'query', + 'schema' => [ + 'description' => '视频流清晰度定义。取值：'."\n" + .'- FD：流畅。'."\n" + .'- LD：标清。'."\n" + .'- SD：高清。'."\n" + .'- HD：超清'."\n" + .'- OD：原画。'."\n" + .'- 2K：2K。'."\n" + .'- 4K：4K。'."\n" + .'- SQ：普通音质。'."\n" + .'- HQ：高音质。', + 'type' => 'string', + 'required' => false, + 'example' => 'HD', + ], + ], + [ + 'name' => 'FileExtension', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体文件扩展名。', + 'type' => 'string', + 'required' => false, + 'example' => 'MP4', + ], + ], + [ + 'name' => 'HDRType', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+'."\n" + .'> - 大小写不敏感。'."\n" + .'> - 非HDR视频该参数为空即可。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HDR10', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****c469e944b5a856828dc2****', + ], + 'FileURL' => [ + 'description' => '文件OSS地址（不带鉴权）。', + 'type' => 'string', + 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + ."\n" + .'> 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + .'> 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'eyJFbmRwb2ludCI6Imm****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', + 'title' => '获取媒体流上传地址和凭证', + 'description' => '### 适用场景'."\n" + .'本接口用于本地上传媒体流'."\n" + .'### 使用限制'."\n" + ."\n" + .'- 本接口仅支持上传至VOD点播存储，不支持上传至用户自有OSS存储。使用自有OSS存储的用户，可以先通过[OSS SDK](~~32006~~)上传文件至OSS，再调用[RegisterMediaStream](~~440765~~)接口将媒体流挂载到指定媒资。'."\n" + .'- 本接口目前仅支持华东2（上海）、华北2（北京）、华南1（深圳）地域。', + ], + 'RefreshUploadMedia' => [ + 'summary' => '本接口用于媒资文件上传超时后重新获取媒资上传凭证，也可用于媒资文件的覆盖上传（即获取到源文件上传地址后重新上传且音/视频ID保持不变）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '411bed50018971edb60b0764a0ec6***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => 'c2e77390f75271ec802f0674a2ce6***', + ], + 'UploadAddress' => [ + 'description' => '上传地址。'."\n" + .'>接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。', + 'type' => 'string', + 'example' => 'eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****', + ], + 'UploadAuth' => [ + 'description' => '上传凭证。'."\n" + .'>接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。', + 'type' => 'string', + 'example' => 'eyJFbmRwb2ludCI6Imm****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"c2e77390f75271ec802f0674a2ce6***\\",\\n \\"UploadAddress\\": \\"eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****\\",\\n \\"UploadAuth\\": \\"eyJFbmRwb2ludCI6Imm****\\"\\n}","type":"json"}]', + 'title' => '刷新媒资上传凭证', + ], + 'RegisterMediaStream' => [ + 'summary' => '该接口用于将OSS上媒体流文件注册到媒体服务，并将该媒体流挂在到指定的MediaId下。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputURL', + 'in' => 'query', + 'schema' => [ + 'description' => '待注册的媒资在相应系统中的地址，一经注册不可更改，并与IMS的mediaId绑定。'."\n" + ."\n" + .'OSS地址，支持两种格式。'."\n" + ."\n" + .'- 标准 HTTP(S) 格式：http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" + ."\n" + .'- OSS 内部格式：oss://example-bucket/example.mp4，此格式默认oss region与服务接入区域一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://***/接口测试/900d1-b8rs8.aac', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5e778ec0027b71ed80a8909598506***', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'StreamTags', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义流标签，用于标识转码流。'."\n" + ."\n" + .'媒体流注册完成后，调用[GetPlayInfo](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-getplayinfo?spm=a2c4g.11186623.help-menu-193643.d_5_0_3_1_4.56dc5a11JzNEVj)可获取此标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '{"key1": "value1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '5e778ec0027b71ed80a8909598506302', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"5e778ec0027b71ed80a8909598506302\\"\\n}","type":"json"}]', + 'title' => '注册媒体流', + ], + 'GetUrlUploadInfos' => [ + 'summary' => '调用GetURLUploadInfos获取URL上传信息，适用于通过URL上传文件的场景，用于查询上传任务的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '上传任务ID（JobId）列表。由一个或多个JobId组成，JobId为通过[UploadMediaByURL](~~86311~~)接口上传时，返回参数JobId的值。'."\n" + .'- 最多支持10个ID。'."\n" + .'- 多个ID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> JobIds和UploadURLs必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => 'df2ac80b481346daa1db6a7c40edc7f8', + ], + ], + [ + 'name' => 'UploadURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '上传视频源文件URL列表。多个URL之间使用半角逗号（,）分隔，最多支持10个。'."\n" + .'> - 使用前，先进行URL编码。'."\n" + .'> - 如果同一URL视频多次上传，建议传入单个URL进行查询。'."\n" + .'> - JobIds和UploadURLs必须指定一个，二者同时传入时只处理JobIds。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://media.w3.org/2010/05/sintel/trailer.mp4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'NonExists' => [ + 'description' => '不存在的ID或URL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不存在的JobId或URL列表。'."\n" + ."\n" + .'- 如果请求参数为JobIds，返回值为JobId；'."\n" + .'- 如果请求参数为UploadURLs，返回值为URL。', + 'type' => 'string', + 'example' => '[\'e3e71ae8e4a46e4893d8cadce50c3bd0\']', + ], + ], + 'URLUploadInfoList' => [ + 'description' => 'URL上传信息详情。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL上传信息列表。具体上传名称及描述，请参见URLUploadInfo：URL上传信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-07T10:03:37Z', + ], + 'Status' => [ + 'description' => 'URL拉取任务状态。具体的拉取状态取值及说明，请参见[Status：URL上传任务状态](~~52839~~)。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'CompleteTime' => [ + 'description' => '完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2021-11-26 21:47:37', + ], + 'JobId' => [ + 'description' => '上传任务ID。', + 'type' => 'string', + 'example' => '3829500c0fef429fa4ec1680b122d***', + ], + 'UserData' => [ + 'description' => '自定义设置。为JSON字符串。', + 'type' => 'string', + 'example' => '{"MessageCallback":"{"CallbackURL":"http://example.aliyundoc.com"}", "Extend":"{"localId":"***", "test":"www"}"}', + ], + 'UploadURL' => [ + 'description' => '上传视频源文件URL。'."\n" + ."\n" + .'> 最多可以返回100条记录。', + 'type' => 'string', + 'example' => 'http://****.mp4', + ], + 'MediaId' => [ + 'description' => '上传视频ID。', + 'type' => 'string', + 'example' => '5014ca70f08171ecbf940764a0fd6***', + ], + 'FileSize' => [ + 'description' => '文件大小。单位：字节。', + 'type' => 'string', + 'example' => '64610', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"NonExists\\": [\\n \\"[\'e3e71ae8e4a46e4893d8cadce50c3bd0\']\\"\\n ],\\n \\"URLUploadInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-07T10:03:37Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"CompleteTime\\": \\"2021-11-26 21:47:37\\",\\n \\"JobId\\": \\"3829500c0fef429fa4ec1680b122d***\\",\\n \\"UserData\\": \\"{\\\\\\"MessageCallback\\\\\\":\\\\\\"{\\\\\\"CallbackURL\\\\\\":\\\\\\"http://example.aliyundoc.com\\\\\\"}\\\\\\", \\\\\\"Extend\\\\\\":\\\\\\"{\\\\\\"localId\\\\\\":\\\\\\"***\\\\\\", \\\\\\"test\\\\\\":\\\\\\"www\\\\\\"}\\\\\\"}\\",\\n \\"UploadURL\\": \\"http://****.mp4\\",\\n \\"MediaId\\": \\"5014ca70f08171ecbf940764a0fd6***\\",\\n \\"FileSize\\": \\"64610\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取URL上传信息', + 'description' => '- 通过URL上传时返回的JobId或者上传时使用的URL来获取URL上传信息，包括URL上传状态、UserData、创建时间、完成时间等。'."\n" + ."\n" + .'- 如果上传失败，可以查看错误码和错误信息，以便诊断问题。'."\n" + ."\n" + .'- 如果上传成功，可以查看对应的视频ID，用于进一步管理和引用。', + ], + 'UploadMediaByURL' => [ + 'summary' => '调用UploadMediaByURL基于源文件URL，拉取音视频媒体文件进行上传，支持批量上传。本接口主要适用于文件没有存储在本地服务器或终端，需要通过公网访问的URL地址上传的场景。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'UploadURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体源文件URL。'."\n" + .'- URL中需要包括扩展名, 比如`https://****.mp4`中mp4为扩展名。'."\n" + .' - 如果URL中不包含扩展名，可以在`UploadMetadatas`中传入`FileExtension`来指定。'."\n" + .' - 如果URL中有扩展名且同时传入`FileExtension`，以传入的`FileExtension`为准。'."\n" + .'- URL编码，多个地址之间以半角逗号（,）分隔，最多支持20个。'."\n" + .'- 避免存在特殊字符导致无法上传视频，需要URL编码后再做逗号拼接。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://diffurl.mp4', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-1000000', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置。为JSON字符串，支持消息回调等设置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}', + ], + ], + [ + 'name' => 'UploadTargetConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '目标存储地址。'."\n" + ."\n" + .'- StorageType 取值：仅支持oss。'."\n" + .'- StorageLocation 仅支持VOD点播存储，不支持用户自有OSS存储。', + 'type' => 'string', + 'required' => false, + 'example' => '{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"}', + ], + ], + [ + 'name' => 'MediaMetaData', + 'in' => 'query', + 'schema' => [ + 'description' => '上传媒体文件的元数据信息，为JSON字符串。'."\n" + .'- 与UploadURLs里的URL匹配才能生效。'."\n" + .'- JSON格式：[UploadMetadata, UploadMetadata,…]，需转为JSON字符串 。'."\n" + .'- 更多信息，请参见下表UploadMetadata。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]', + ], + ], + [ + 'name' => 'PostProcessConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Type = video || audio 有上传后处理动作。'."\n" + ."\n" + .'ProcessType取值：Workflow。', + 'type' => 'string', + 'required' => false, + 'example' => '{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"}', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体 ID。可调用CreateEntity接口创建实体，自定义动态元数据结构。', + 'type' => 'string', + 'required' => false, + 'example' => 'd67281da3c8743b8823ad12976187***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', + ], + 'UploadJobs' => [ + 'description' => '多个Job信息。', + 'type' => 'array', + 'items' => [ + 'description' => '上传任务详情。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '上传任务ID。', + 'type' => 'string', + 'example' => '20ce1e05dba64576b96e9683879f0***', + ], + 'SourceURL' => [ + 'description' => '上传任务对应的源文件URL。', + 'type' => 'string', + 'example' => 'http://example****.mp4'."\n", + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => 'f476988629f54a7b8a4ba90d1a6c7***', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"UploadJobs\\": [\\n {\\n \\"JobId\\": \\"20ce1e05dba64576b96e9683879f0***\\",\\n \\"SourceURL\\": \\"http://example****.mp4\\\\n\\",\\n \\"MediaId\\": \\"f476988629f54a7b8a4ba90d1a6c7***\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'URL拉取上传', + 'description' => '### 接口说明'."\n" + .'- 如果配置了回调，则上传完成后会收到URL上传视频完成的事件通知，可以通过获取URL上传信息接口查询上传状态。'."\n" + .'- 上传任务提交成功后，会在云端生成异步执行的任务，进行排队执行；上传完成后可根据事件通知（消息回调）返回的URL和视频ID等信息进行关联。'."\n" + .'### 使用限制'."\n" + .'- 本接口仅支持上传至VOD点播存储，不支持上传至用户自有OSS存储。使用自有OSS存储的用户，可以先将文件拉取到本地，通过[OSS SDK](~~32006~~)上传文件至OSS，然后再调用[RegisterMediaInfo](~~441152~~)接口将OSS文件注册至媒资库。'."\n" + .'- 本接口目前仅支持华东2（上海）、华北2（北京）、华南1（深圳）地域。'."\n" + ."\n" + .'- 本接口仅支持上传音视频文件。', + 'requestParamsDescription' => '## UploadMetadata'."\n" + ."\n" + .'| 名称 | 类型 | 是否必需 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| SourceURL | String | 是 | 需要上传的媒体源文件URL。|'."\n" + .'| Title |String |是 |媒体标题。长度不超过128个字节。UTF-8编码。|'."\n" + .'| FileSize| String |否 |文件大小。|'."\n" + .'| Description| String |否 |描述。长度不超过1024个字节。UTF-8编码。|'."\n" + .'| CoverURL |String |否 |自定义视频封面URL地址。|'."\n" + .'| CateId |String |否 |分类ID。'."\n" + .'| Tags |String |否 |标签。单个标签不超过32字节，最多不超过16个标签。多个标签，请使用半角逗号（,）分隔。UTF8编码。|'."\n" + .'|WorkflowId |String |否 |工作流ID。|'."\n" + .'|FileExtension |String |否| 媒体文件扩展名。|'."\n" + .'|DynamicMetaData |String |否| 动态元数据，例："{\\"Uploader\\": \\"xxx\\"}"。|'."\n" + .'|EntityId |String |否| 实体Id。|'."\n" + ."\n" + .'> - UploadMetadata 中的参数（如Title、Description、Tags等）不能包含表情符。'."\n" + .'> - 如果配置了回调，视频上传完成后，除了上传和转码通知，还有URL上传视频完成件通知。'."\n" + .'> - 批量提交时，每一个SourceURL有独立的通知。', + ], + 'UploadStreamByURL' => [ + 'summary' => '调用UploadStreamByURL基于源文件URL，拉取媒体流文件并上传至VOD点播存储中。上传完成后，该媒体流将自动挂载到指定的MediaId下。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'StreamURL', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流文件URL。'."\n" + ."\n" + .'如果转码流的URL需要鉴权，需要在StreamURL中传入鉴权参数，并确保该URL可以通过公网访问。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com/sample-stream.mp4', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '411bed50018971edb60b0764a0ec6***', + ], + ], + [ + 'name' => 'Definition', + 'in' => 'query', + 'schema' => [ + 'description' => '视频流清晰度定义。取值：'."\n" + .'- FD：流畅。'."\n" + .'- LD：标清。'."\n" + .'- SD：高清。'."\n" + .'- HD：超清'."\n" + .'- OD：原画。'."\n" + .'- 2K：2K。'."\n" + .'- 4K：4K。'."\n" + .'- SQ：普通音质。'."\n" + .'- HQ：高音质。', + 'type' => 'string', + 'required' => false, + 'example' => 'HD', + ], + ], + [ + 'name' => 'FileExtension', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体文件扩展名。', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + ], + [ + 'name' => 'HDRType', + 'in' => 'query', + 'schema' => [ + 'description' => '转码流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+'."\n" + .'> - 大小写不敏感。'."\n" + .'> - 非HDR视频该参数为空即可。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HDR10', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MessageCallback":{"CallbackURL":"http://test.test.com"}, "Extend":{"localId":"xxx","test":"www"}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******89-C21D-4B78-AE24-3788B8******', + ], + 'JobId' => [ + 'description' => '上传任务ID。', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '411bed50018971edb60b0764a0ec6***', + ], + 'FileURL' => [ + 'description' => '文件OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4', + ], + 'SourceURL' => [ + 'description' => '上传任务对应的源文件URL。', + 'type' => 'string', + 'example' => 'https://example.com/sample-stream.mp4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******89-C21D-4B78-AE24-3788B8******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"MediaId\\": \\"411bed50018971edb60b0764a0ec6***\\",\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/stream/48555e8b-181dd5a8c07/48555e8b-181dd5a8c07.mp4\\",\\n \\"SourceURL\\": \\"https://example.com/sample-stream.mp4\\"\\n}","type":"json"}]', + 'title' => '媒体流URL拉取上传', + 'description' => '- 本接口仅支持上传至VOD点播存储，不支持上传至用户自有OSS存储。使用自有OSS存储的用户，可以先将文件拉取到本地，通过[OSS SDK](~~32006~~)上传文件至OSS，然后再调用[RegisterMediaStream](~~440765~~)将媒体流挂载到指定媒资。'."\n" + .'- 本接口目前仅支持华东2（上海）、华北2（北京）、华南1（深圳）地域。', + ], + 'CloseStreamToSearchLib' => [ + 'summary' => '关闭流媒资，关闭后停止打标和分析。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库', + 'type' => 'string', + 'required' => false, + 'example' => 'Stream_xxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****c469e944b5a856828dc2****'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\\\n\\"\\n}","type":"json"}]', + 'title' => '关闭流媒资', + ], + 'GetStreamTagList' => [ + 'summary' => '查询流媒资打标信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库', + 'type' => 'string', + 'required' => false, + 'example' => 'Stream_xxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '******b48fb04483915d4f2cd8******', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'StartTime（打标时间）的开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-04-23T02:26:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'StartTime（打标时间）的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询当前页，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小，[1, 50]，不传默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- StartTime:Desc（默认值）：按创建时间倒序。'."\n" + .'- StartTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'StartTime:Asc', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => '****73f33c91-d59383e8280b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'NextToken' => [ + 'description' => '查询凭证。', + 'type' => 'string', + 'example' => '****73f33c91-d59383e8280b****', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163', + ], + 'StreamTagList' => [ + 'description' => '打标信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2025-04-26T16:00:00Z', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2025-02-25T02:24:00Z', + ], + 'UserData' => [ + 'description' => '用户自定义数据。', + 'type' => 'string', + 'example' => '{"result":"xxx"}', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"NextToken\\": \\"****73f33c91-d59383e8280b****\\",\\n \\"Total\\": 163,\\n \\"StreamTagList\\": [\\n {\\n \\"StartTime\\": \\"2025-04-26T16:00:00Z\\",\\n \\"EndTime\\": \\"2025-02-25T02:24:00Z\\",\\n \\"UserData\\": \\"{\\\\\\"result\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取流媒资打标', + ], + 'CreateStreamToSearchLib' => [ + 'summary' => '创建流媒资，把直播流注册为媒资。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库', + 'type' => 'string', + 'required' => false, + 'example' => 'Stream_xxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '输入直播流URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '表示是否调用成功。'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '创建流媒资', + ], + 'AddStreamTagToSearchLib' => [ + 'summary' => '针对流媒资进行打标。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库', + 'type' => 'string', + 'required' => false, + 'example' => 'Stream_xxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '******b48fb04483915d4f2cd8******', + ], + ], + [ + 'name' => 'MsgBody', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资信息消息体。', + 'type' => 'string', + 'required' => false, + 'example' => '{"startTime":1657684600793,"endTime":1657684600793,"userData":"{}"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '添加流媒资标签', + 'description' => '针对直播流创建的媒资进行打标。', + ], + 'CreateSearchLib' => [ + 'summary' => '用户新建搜索媒资库。可以用来保存媒资。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。数字字母组合。网络监控摄像头IPC场景前缀必须为"IPCamera_"，其他自定义即可。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'SearchLibConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库配置', + 'description' => '搜索库配置。JSON string格式。其中字段'."\n" + .'- faceGroupIds ：自注册人脸库ID，来着CreateRecognitionLib创建，最多支持3个自注册人脸库根据英文","拼接', + 'type' => 'string', + 'required' => false, + 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'SearchLibName' => [ + 'description' => '搜索库名称。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', + 'title' => '创建搜索库', + ], + 'QuerySearchLib' => [ + 'summary' => '查询搜索媒资库信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '表示是否调用成功：'."\n" + .'- true：调用成功'."\n" + .'- false：调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'SearchLibName' => [ + 'description' => '搜索库名称。', + 'type' => 'string', + 'example' => 'test1', + ], + 'Status' => [ + 'description' => '状态：'."\n" + .'- 正常'."\n" + .'- 删除中'."\n" + .'- 删除失败', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => 'normal', + 'deleting' => 'deleting', + 'deleteFail' => 'deleteFail', + ], + 'example' => 'normal', + ], + 'IndexInfo' => [ + 'description' => '索引信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IndexType' => [ + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'example' => 'face', + ], + 'IndexStatus' => [ + 'description' => '索引状态。取值：'."\n" + .'- Active：激活。'."\n" + .'- Deactive：失效。', + 'type' => 'string', + 'example' => 'Active', + ], + 'IndexReadiness' => [ + 'description' => '索引就绪状态。取值：'."\n" + .'- Initializing：初始化。'."\n" + .'- Normal：正常。'."\n" + .'- Fail：失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + 'SearchLibConfig' => [ + 'title' => '搜索库配置', + 'description' => '搜索库配置。', + 'type' => 'string', + 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\",\\n \\"Status\\": \\"normal\\",\\n \\"IndexInfo\\": [\\n {\\n \\"IndexType\\": \\"face\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"IndexReadiness\\": \\"Normal\\"\\n }\\n ],\\n \\"SearchLibConfig\\": \\"{\\\\\\"faceGroupIds\\\\\\":\\\\\\"xxx1,xxx2,xx3\\\\\\"}\\"\\n}","type":"json"}]', + 'title' => '查询搜索库', + ], + 'ListSearchLib' => [ + 'summary' => '获取搜索库列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237778', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的数据条数。默认值为 10，最大值为 50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'SearchLibInfoList' => [ + 'description' => '搜索库信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '搜索库信息。', + 'type' => 'object', + 'properties' => [ + 'SearchLibName' => [ + 'description' => '搜索库。', + 'type' => 'string', + 'example' => 'faceSearchLib', + ], + 'Status' => [ + 'description' => '状态：'."\n" + ."\n" + .'- normal：正常'."\n" + .'- deleting：删除中'."\n" + .'- deleteFail：删除失败', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => 'normal', + 'deleting' => 'deleting', + 'deleteFail' => 'deleteFail', + ], + 'example' => 'normal', + ], + 'IndexInfo' => [ + 'description' => '索引信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IndexType' => [ + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'example' => 'face', + ], + 'IndexStatus' => [ + 'description' => '索引状态。默认值为Active，取值：'."\n" + .'- Active：激活。'."\n" + .'- Deactive：失效。', + 'type' => 'string', + 'example' => 'Active', + ], + 'IndexReadiness' => [ + 'description' => '索引就绪状态。取值：'."\n" + .'- Initializing：激活。'."\n" + .'- Normal：失效。'."\n" + .'- Fail：失败。', + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + 'SearchLibConfig' => [ + 'title' => '搜索库配置', + 'description' => '搜索库配置。', + 'type' => 'string', + 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibInfoList\\": [\\n {\\n \\"SearchLibName\\": \\"faceSearchLib\\",\\n \\"Status\\": \\"normal\\",\\n \\"IndexInfo\\": [\\n {\\n \\"IndexType\\": \\"face\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"IndexReadiness\\": \\"Normal\\"\\n }\\n ],\\n \\"SearchLibConfig\\": \\"{\\\\\\"faceGroupIds\\\\\\":\\\\\\"xxx1,xxx2,xx3\\\\\\"}\\"\\n }\\n ],\\n \\"Total\\": 8\\n}","type":"json"}]', + 'title' => '获取搜索库列表', + ], + 'AlterSearchLib' => [ + 'summary' => '修改搜索库。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'SearchLibConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库配置。JSON string格式。其中字段'."\n" + .'- faceGroupIds ：自注册人脸库ID，来着CreateRecognitionLib创建，最多支持3个自注册人脸库根据英文","拼接', + 'type' => 'string', + 'required' => false, + 'example' => '{"faceGroupIds":"xxx1,xxx2,xx3"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'SearchLibName' => [ + 'description' => '搜索库名称。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\"\\n}","type":"json"}]', + 'title' => '修改搜索库', + ], + 'DropSearchLib' => [ + 'summary' => '删除搜索媒资库。删除库下所有媒资。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '删除搜索库', + ], + 'CreateSearchIndex' => [ + 'summary' => '可以在搜索库下新增搜索索引。一个搜索库下可以有多个不同类型搜索索引。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。'."\n" + ."\n" + .'- 未填写搜索库名称时，默认情况下搜索索引会被创建在IMS的默认搜索库下。默认值ims-default-search-lib。'."\n" + .'- 您还可以通过[QuerySearchLib](~~2584455~~)接口查询已有的搜索库信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'IndexType', + 'in' => 'query', + 'schema' => [ + 'title' => '索引类别', + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型视觉状态。用于描述视频中的复杂视觉特征和动作，可以帮助识别和搜索视频中特定的动作、运动以及事件。如足球运动员射球进门、篮球运动员受伤等情况。'."\n" + .'> '."\n" + .'> 共享型支持1000小时的视频，超出后，系统将不再进行大模型视觉状态分析。'."\n" + .'- face：人脸自动识别。用于描述视频中的人脸特征，通过人脸识别技术，可以对视频中的人脸进行自动标记和搜索。'."\n" + .'> '."\n" + .'> 共享型支持100万人脸分析，超出后，系统将不再进行人脸分析。'."\n" + .'- aiLabel：智能标签。智能标签索引类别用于描述视频中的字幕、语音等内容。通过文本和语音识别技术，可以自动提取视频中的字幕、对话等语言信息进行标记和搜索。帮助用户快速搜索和定位视频中涉及特定话题或关键字的内容。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'mm' => 'mm', + 'face' => 'face', + 'aiLabel' => 'aiLabel', + ], + 'example' => 'mm', + ], + ], + [ + 'name' => 'IndexStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '索引状态。默认值Active。取值：'."\n" + .'- Active：激活。'."\n" + .'- Deactive：失效。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Active' => 'Active', + 'Deactive' => 'Deactive', + ], + 'example' => 'Active', + ], + ], + [ + 'name' => 'IndexConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '索引配置', + 'description' => '索引配置', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'Success' => [ + 'description' => '是否调用成功，取值：'."\n" + .'- true：调用成功 '."\n" + .'- false：调用失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '创建搜索索引', + 'description' => '<props="china">请确保在使用该接口前，已充分了解[智能检索收费](~~2840897~~)方式和价格。</props>', + 'requestParamsDescription' => '### IndexConfig说明'."\n" + .'| 功能 | 名称 | 类型 | 必填 | 描述 | 示例值 |'."\n" + .'| --- | --- | --- | --- | --- | --- |'."\n" + .'| | IndexConfig | object | 否 | 该参数包含了索引配置的相关参数 | {"level":"Shared"}|'."\n" + .'| 规格| level | string | 否 | 人脸face、大模型mm下资源规格参数，默认值为Shared。<br>取值范围：<ul><li>Shared - 共享型，支持100万人脸或1000小时视频大模型分析</li><li>S.large - 独享型，支持100万人脸或1万小时视频大模型分析</li><li>S.2xlarge - 独享型，支持200万人脸或2万小时视频大模型分析</li><li>S.4xlarge - 独享型，支持400万人脸或4万小时视频大模型分析</li><li>S.8xlarge - 独享型，支持800万人脸或8万小时视频大模型分析</li><li>S.16xlarge - 独享型，支持1600万人脸或16万小时视频大模型分析</li></ul>| "Shared"', + ], + 'AlterSearchIndex' => [ + 'summary' => '修改搜索索引信息（索引状态或索引配置）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。'."\n" + ."\n" + .'- 未填写搜索库名称时，默认情况下搜索索引会被创建在IMS的默认搜索库下。默认值ims-default-search-lib。'."\n" + .'- 您还可以通过[QuerySearchLib](~~2584455~~)接口查询已有的搜索库信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'IndexType', + 'in' => 'query', + 'schema' => [ + 'title' => '索引类别', + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'mm' => 'mm', + 'face' => 'face', + 'aiLabel' => 'aiLabel', + ], + 'example' => 'mm', + ], + ], + [ + 'name' => 'IndexStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '索引状态。默认值为Active，取值：'."\n" + .'- Active：激活。'."\n" + .'- Deactive：失效。'."\n" + ."\n" + .'><notice> 必须填写IndexStatus或IndexConfig两个参数中的一个。></notice>', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Active' => 'Active', + 'Deactive' => 'Deactive', + ], + 'example' => 'Active', + ], + ], + [ + 'name' => 'IndexConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '索引配置', + 'description' => '索引配置。'."\n" + .'><notice> 必须填写IndexStatus或IndexConfig两个参数中的一个。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '修改搜索索引', + ], + 'QuerySearchIndex' => [ + 'summary' => '查询搜索索引详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。'."\n" + .'- 未填写搜索库名称时，默认情况下搜索索引会被创建在IMS的默认搜索库下。默认值ims-default-search-lib。'."\n" + .'- 您还可以通过[QuerySearchLib](~~2584455~~)接口查询已有的搜索库信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'IndexType', + 'in' => 'query', + 'schema' => [ + 'title' => '索引类别', + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'mm' => 'mm', + ], + 'example' => 'mm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'SearchLibName' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。', + 'type' => 'string', + 'example' => 'test1', + ], + 'IndexType' => [ + 'title' => '索引类别', + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'mm' => 'mm', + 'face' => 'face', + 'aiLabel' => 'aiLabel', + ], + 'example' => 'mm', + ], + 'IndexStatus' => [ + 'description' => '索引状态。取值：'."\n" + .'- Active：激活。'."\n" + .'- Deactive：失效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Active' => 'Active', + 'Deactive' => 'Deactive', + ], + 'example' => 'Active', + ], + 'MediaTotal' => [ + 'description' => '媒资总数。', + 'type' => 'string', + 'example' => '12', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"SearchLibName\\": \\"test1\\",\\n \\"IndexType\\": \\"mm\\",\\n \\"IndexStatus\\": \\"Active\\",\\n \\"MediaTotal\\": \\"12\\"\\n}","type":"json"}]', + 'title' => '查询搜索索引', + ], + 'DropSearchIndex' => [ + 'summary' => '删除索引，删除后对应索引存量数据会被删除，新增媒资也不再支持对应索引分析、存储、搜索。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。'."\n" + ."\n" + .'- 未填写搜索库名称时，默认情况下搜索索引会被创建在IMS的默认搜索库下。默认值ims-default-search-lib。'."\n" + .'- 您还可以通过[QuerySearchLib](~~2584455~~)接口查询已有的搜索库信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'IndexType', + 'in' => 'query', + 'schema' => [ + 'title' => '索引类别', + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'mm' => 'mm', + ], + 'example' => 'mm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '删除搜索索引', + ], + 'QueryMediaIndexJob' => [ + 'summary' => '查询媒资对应开启的索引任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库名称。默认值ims-default-search-lib。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID', + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c2e77390f75271ec802f0674a2ce6***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'IndexJobInfoList' => [ + 'description' => '索引任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '索引任务信息。', + 'type' => 'object', + 'properties' => [ + 'GmtSubmit' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'example' => '2023-11-21 11:33:50', + ], + 'GmtFinish' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2023-11-21 11:33:51', + ], + 'IndexType' => [ + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'enumValueTitles' => [ + 'mm' => 'mm', + 'face' => 'face', + 'aiLabel' => 'aiLabel', + ], + 'example' => 'mm', + ], + 'Status' => [ + 'description' => '任务状态，取值： '."\n" + .'- Running：运行中。'."\n" + .'- Success: 成功。'."\n" + .'- Fail: 失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Running' => 'Running', + 'Success' => 'Success', + 'Fail' => 'Fail', + ], + 'example' => 'Success', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"IndexJobInfoList\\": [\\n {\\n \\"GmtSubmit\\": \\"2023-11-21 11:33:50\\",\\n \\"GmtFinish\\": \\"2023-11-21 11:33:51\\",\\n \\"IndexType\\": \\"mm\\",\\n \\"Status\\": \\"Success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询媒资索引任务', + ], + 'SearchIndexJobRerun' => [ + 'summary' => '批量重新分析指定媒资的搜索索引任务。每次请求最多可以重跑20个媒资的索引任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236859', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'title' => '索引类别', + 'description' => '媒资ID。多个用英文逗号分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。多个用英文逗号分割。'."\n" + .'- aiLabel：智能标签。'."\n" + .'- face：人脸。'."\n" + .'- mm：大模型。', + 'type' => 'string', + 'required' => false, + 'example' => 'aiLabel,face,mm', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'MediaIdsNoExist' => [ + 'description' => '媒资ID不存在列表。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '1c6ce34007d571ed94667630a6bc****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"MediaIdsNoExist\\": [\\n \\"1c6ce34007d571ed94667630a6bc****\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '搜索索引任务重跑', + ], + 'InsertMediaToSearchLib' => [ + 'summary' => '插入媒资到搜索库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库名称。需要调用CreateSearchLib接口提前建立好搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。具有唯一性，不填会自动生成。', + 'type' => 'string', + 'required' => false, + 'example' => '411bed50018971edb60b0764a0ec6***', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资类型。默认值video。'."\n" + .'- video视频'."\n" + .'- image图片'."\n" + .'- audio音频', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => 'image', + 'video' => 'video', + 'audio' => 'audio', + ], + 'example' => 'video', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '需要入库的视频、音频或图片文件的地址，请勿使用临时地址，需保证源文件可以被访问。'."\n" + ."\n" + .'> 请确认您的文件名正确且所在Bucket与接口调用地域一致，否则可能导致找不到文件或接口调用失败。'."\n" + .'>- OSS地址（推荐）：oss://[Bucket名称]/[文件路径]，例如oss://[example-bucket-****]/[object_path-****]。'."\n" + .'>- HTTP地址：公网可下载的地址，例如http://example-test-****.mp4。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://[example-bucket-]/[object_path-]', + ], + ], + [ + 'name' => 'MsgBody', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资信息。JSON字符串。支持字段：'."\n" + .'- title，标题，string类型'."\n" + .'- customFields，自定义字段，JSONObject，参数不支持修改；支持Int型intField1、string型strField1、strField2', + 'type' => 'string', + 'required' => false, + 'example' => '{"title":"test","customFields":{"intField1":12,"strField1":"abc"}}', + ], + ], + [ + 'name' => 'ImagesInput', + 'in' => 'query', + 'schema' => [ + 'description' => '图片集信息。仅支持IPCamera场景，MediaType需为video。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "images": ['."\n" + .' "oss://[example-bucket-]/[object_path-]xxx1.jpg",'."\n" + .' "oss://[example-bucket-]/[object_path-]xxx2.jpg",'."\n" + .' "oss://[example-bucket-]/[object_path-]xxx3.jpg",'."\n" + .' "oss://[example-bucket-]/[object_path-]xxx4.jpg"'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '插入媒资到搜索库', + 'description' => '### 前提条件'."\n" + .'插入媒资到搜索库前，需要调用[CreateSearchLib](~~2584454~~)接口建立好搜索库。', + ], + 'UpdateMediaToSearchLib' => [ + 'summary' => '在搜索库中更新媒资信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库名称。需要调用CreateSearchLib接口提前建立好搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****019b82e24b37a1c2958dec38****', + ], + ], + [ + 'name' => 'MsgBody', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资信息消息体。', + 'type' => 'string', + 'required' => true, + 'example' => '{}', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '******b48fb04483915d4f2cd8******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '更新媒资到搜索库', + ], + 'DeleteMediaFromSearchLib' => [ + 'summary' => '在搜索库中删除指定媒资。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库名称。需要调用CreateSearchLib接口提前建立好搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'MsgBody', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资信息消息体。', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '******b48fb04483915d4f2cd8******', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '删除媒资从搜索库', + ], + 'SearchMedia' => [ + 'summary' => '根据用户所提供参数，返回符合条件的媒资信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140243', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'Match', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '过滤条件。<props="china">语法规则，请参见[媒资搜索协议](~~2584256~~)。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'title = \'中国\' and utcCreate = [\'1693367158561\',\'1693367158562\']', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', + 'description' => '排序字段和排序顺序。多个使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'utcCreate:Desc', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '实体Id', + 'description' => '实体ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2d3bf1e35a1e42b5ab338d701efa****', + ], + ], + [ + 'name' => 'ScrollToken', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页标识。32字段。第一次执行搜索请求时不用设置本参数。搜索请求命中数据时，服务端会返回该参数值，用于记录当前搜索数据的位置地址。请记录返回的参数值，下一次搜索时按下述要求或建议设置本参数：需要遍历搜索条件命中的所有数据时，本参数必须设置。当PageNo参数取值超过200时，建议设置本参数优化搜索性能。只能向后翻页，最大翻页距离为1000媒资。', + 'type' => 'string', + 'required' => false, + 'example' => 'F8C4F642184DBDA5D93907A70AAE****', + ], + ], + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义过滤', + 'description' => '自定义过滤。JOSN字符串；支持字段Int型intField1、字符串型strField1、strField2；同一个字段最多可选择一种匹配，不通字段过滤时是且关系。'."\n" + .'- 精准，如 {"intField1":12,"strField1":"abc"}'."\n" + .'- 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]}'."\n" + .'- 范围，如 {"intField1":{"gte":12,"lte":13}}', + 'type' => 'string', + 'required' => false, + 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6F61C357-ACC0-57FB-876E-D5879533****', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'string', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaInfoList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息列表。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '3b187b3620c8490886cfc2a9578c****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => '媒资基础信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '132bd600fc3c71ec99476732a78f****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址。', + 'type' => 'string', + 'example' => 'oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型。', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。', + 'type' => 'string', + 'example' => 'opening', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题。', + 'type' => 'string', + 'example' => '智能横屏转竖屏', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述。', + 'type' => 'string', + 'example' => '对这个视频进行转码处理了', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类。', + 'type' => 'string', + 'example' => 'image', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tags,tags2'."\n", + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址。', + 'type' => 'string', + 'example' => 'https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'userData', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图。', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态。', + 'type' => 'string', + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间。', + 'type' => 'string', + 'example' => '2020-12-01T19:48Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间。', + 'type' => 'string', + 'example' => '2020-12-01T19:48Z'."\n", + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间。', + 'type' => 'string', + 'example' => '2020-12-01T19:48Z'."\n", + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图。', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44', + ], + 'Biz' => [ + 'description' => '媒资所属业务。', + 'type' => 'string', + 'example' => 'IMS', + ], + 'UploadSource' => [ + 'description' => '上传资源。', + 'type' => 'string', + 'example' => 'general', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '子分类1', + ], + 'ReferenceId' => [ + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'name-1', + ], + 'VisionDescription' => [ + 'description' => '视觉描述。', + 'type' => 'string', + 'example' => '足球进球', + ], + 'StreamStatus' => [ + 'title' => '流状态', + 'description' => '流状态', + 'type' => 'string', + 'example' => 'Active', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfos。', + 'type' => 'array', + 'items' => [ + 'description' => 'fileinfo列表。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等。', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名。', + 'type' => 'string', + 'example' => '164265080291300080527050.wav', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）。', + 'type' => 'string', + 'example' => '324784', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址。', + 'type' => 'string', + 'example' => 'https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长。', + 'type' => 'string', + 'example' => '60.00000'."\n", + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率。', + 'type' => 'string', + 'example' => '1912.13'."\n", + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '480', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-05-30T02:02:17Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2021-12-10T12:19Z', + ], + 'ImagesInput' => [ + 'description' => '图片集信息。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + 'AiData' => [ + 'description' => 'AI详细信息', + 'type' => 'object', + 'properties' => [ + 'AiLabelInfo' => [ + 'description' => 'AI标签信息列表', + 'type' => 'array', + 'items' => [ + 'description' => 'AI标签信息', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****', + ], + 'LabelType' => [ + 'description' => '标签类型', + 'type' => 'string', + 'example' => '物体', + ], + 'Source' => [ + 'description' => '来源', + 'type' => 'string', + 'example' => 'vision', + ], + 'Category' => [ + 'description' => '分类', + 'type' => 'string', + 'example' => '交通工具', + ], + 'LabelName' => [ + 'description' => '实体名称', + 'type' => 'string', + 'example' => '车', + ], + 'LabelId' => [ + 'description' => '实体ID', + 'type' => 'string', + 'example' => '10310250338', + ], + 'Occurrences' => [ + 'description' => '片段列表', + 'type' => 'array', + 'items' => [ + 'description' => '片段', + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '打分', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.75287705', + ], + 'Image' => [ + 'description' => '最优人脸图片的base64编码', + 'type' => 'string', + 'example' => '99C64F6287', + ], + 'TableBatchSeqId' => [ + 'description' => '向量表序列ID', + 'type' => 'string', + 'example' => '85010D1', + ], + 'clipId' => [ + 'description' => '片段ID', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****', + ], + 'From' => [ + 'description' => '片段起始时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'FinegrainName' => [ + 'description' => '实体的细粒度名称', + 'type' => 'string', + 'example' => '车', + ], + 'FinegrainId' => [ + 'description' => '实体的细粒度ID', + 'type' => 'string', + 'example' => '10310250338', + ], + 'Content' => [ + 'description' => '文本内容', + 'type' => 'string', + 'example' => '皮皮', + ], + 'Tracks' => [ + 'description' => 'track序列', + 'type' => 'array', + 'items' => [ + 'description' => '序列', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '人脸bbox框的面积', + 'type' => 'number', + 'format' => 'double', + 'example' => '50.2', + ], + 'Position' => [ + 'description' => 'bbox框位置坐标', + 'type' => 'string', + 'example' => '468.0;67.0;615.0;267.0', + ], + 'Timestamp' => [ + 'description' => 'track的时间戳', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AsrInfo' => [ + 'description' => '语音信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '语音信息', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'ClipId' => [ + 'description' => '片段ID', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****', + ], + 'Content' => [ + 'description' => '文本内容', + 'type' => 'string', + 'example' => '我是皮皮', + ], + 'Timestamp' => [ + 'description' => '片段时间戳', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + 'OcrInfo' => [ + 'description' => '字幕信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '字幕信息', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'ClipId' => [ + 'description' => '片段ID', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****', + ], + 'Content' => [ + 'description' => '文本内容', + 'type' => 'string', + 'example' => '我是皮皮', + ], + 'Timestamp' => [ + 'description' => '片段时间戳', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + ], + ], + 'AiRoughData' => [ + 'description' => 'AI简介数据', + 'type' => 'object', + 'properties' => [ + 'SaveType' => [ + 'description' => '保存类型', + 'type' => 'string', + 'example' => 'TEXT', + ], + 'Status' => [ + 'description' => '数据状态', + 'type' => 'string', + 'example' => 'SaveSuccess', + ], + 'AiJobId' => [ + 'description' => 'AI任务ID', + 'type' => 'string', + 'example' => 'cd35b0b0025f71edbfcb472190a9****', + ], + 'Result' => [ + 'description' => 'AI结果', + 'type' => 'string', + 'example' => 'http://xxxx.json', + ], + 'AiCategory' => [ + 'description' => '电视剧', + 'type' => 'string', + 'example' => '视频AI分类', + ], + ], + ], + 'IndexStatusList' => [ + 'description' => '索引状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '索引状态。', + 'type' => 'object', + 'properties' => [ + 'IndexType' => [ + 'description' => '索引类别。取值：'."\n" + .'- mm：大模型。'."\n" + .'- face：人脸。'."\n" + .'- aiLabel：智能标签。', + 'type' => 'string', + 'example' => 'mm', + ], + 'IndexStatus' => [ + 'description' => '索引状态。取值：'."\n" + .'- Running：运行中。'."\n" + .'- Fail：失败。'."\n" + .'- Success: 成功。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + 'CustomFields' => [ + 'title' => '自定义过滤参数', + 'description' => '自定义过滤参数。', + 'type' => 'string', + 'example' => '{\\"intField1\\":12,\\"strField1\\":\\"abc\\"}', + ], + ], + ], + ], + 'ScrollToken' => [ + 'description' => '翻页标识。', + 'type' => 'string', + 'example' => 'F8C4F642184DBDA5D93907A70AAE****', + ], + 'Total' => [ + 'description' => '符合条件的媒资总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F61C357-ACC0-57FB-876E-D5879533****\\",\\n \\"Success\\": \\"True\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaInfoList\\": [\\n {\\n \\"MediaId\\": \\"3b187b3620c8490886cfc2a9578c****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"132bd600fc3c71ec99476732a78f****\\",\\n \\"InputURL\\": \\"oss://clipres/longvideo/material/voice/prod/20220418/07d7c799f6054dc3bbef250854cf8498165024814****\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"opening\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"智能横屏转竖屏\\",\\n \\"Description\\": \\"对这个视频进行转码处理了\\",\\n \\"Category\\": \\"image\\",\\n \\"MediaTags\\": \\"tags,tags2\\\\n\\",\\n \\"CoverURL\\": \\"https://dtlive-bj.oss-cn-beijing.aliyuncs.com/cover/e694372e-4f5b-4821-ae09-efd064f2****_large_cover_url.jpg\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"3\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******f48f0e4154976b2b8c45******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-beijing\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e6a6440b29eb60bd7c******\\\\\\"}]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-01T19:48Z\\",\\n \\"ModifiedTime\\": \\"2020-12-01T19:48Z\\\\n\\",\\n \\"DeletedTime\\": \\"2020-12-01T19:48Z\\\\n\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 44,\\n \\"Biz\\": \\"IMS\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"CateName\\": \\"子分类1\\",\\n \\"ReferenceId\\": \\"123-123\\",\\n \\"Namespace\\": \\"name-1\\",\\n \\"VisionDescription\\": \\"足球进球\\",\\n \\"StreamStatus\\": \\"Active\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"164265080291300080527050.wav\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"324784\\",\\n \\"FileUrl\\": \\"https://outin-d3f4681ddfd911ec99a600163e1403e7.oss-cn-shanghai.aliyuncs.com/sv/23d5cdd1-18180984899/23d5cdd1-1818098****.mp4\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"60.00000\\\\n\\",\\n \\"Bitrate\\": \\"1912.13\\\\n\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"480\\",\\n \\"CreateTime\\": \\"2022-05-30T02:02:17Z\\",\\n \\"ModifiedTime\\": \\"2021-12-10T12:19Z\\",\\n \\"ImagesInput\\": \\"{}\\"\\n }\\n }\\n ],\\n \\"AiData\\": {\\n \\"AiLabelInfo\\": [\\n {\\n \\"FaceId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"LabelType\\": \\"物体\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"交通工具\\",\\n \\"LabelName\\": \\"车\\",\\n \\"LabelId\\": \\"10310250338\\",\\n \\"Occurrences\\": [\\n {\\n \\"Score\\": 0.75287705,\\n \\"Image\\": \\"99C64F6287\\",\\n \\"TableBatchSeqId\\": \\"85010D1\\",\\n \\"clipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"FinegrainName\\": \\"车\\",\\n \\"FinegrainId\\": \\"10310250338\\",\\n \\"Content\\": \\"皮皮\\",\\n \\"Tracks\\": [\\n {\\n \\"Size\\": 50.2,\\n \\"Position\\": \\"468.0;67.0;615.0;267.0\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"AsrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"我是皮皮\\",\\n \\"Timestamp\\": 1.4\\n }\\n ],\\n \\"OcrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"我是皮皮\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n },\\n \\"AiRoughData\\": {\\n \\"SaveType\\": \\"TEXT\\",\\n \\"Status\\": \\"SaveSuccess\\",\\n \\"AiJobId\\": \\"cd35b0b0025f71edbfcb472190a9****\\",\\n \\"Result\\": \\"http://xxxx.json\\",\\n \\"AiCategory\\": \\"视频AI分类\\"\\n },\\n \\"IndexStatusList\\": [\\n {\\n \\"IndexType\\": \\"mm\\",\\n \\"IndexStatus\\": \\"Success\\"\\n }\\n ],\\n \\"CustomFields\\": \\"{\\\\\\\\\\\\\\"intField1\\\\\\\\\\\\\\":12,\\\\\\\\\\\\\\"strField1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"abc\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ScrollToken\\": \\"F8C4F642184DBDA5D93907A70AAE****\\",\\n \\"Total\\": 163\\n}","type":"json"}]', + 'title' => '搜索媒体信息', + 'description' => '阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等，请搜索钉钉群（30415005038）加入智能媒体服务多模检索客户答疑群联系我们。', + ], + 'GetVideoList' => [ + 'summary' => '获取视频信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '781111', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索结果中返回的媒资字段。 默认只返回基本媒资字段，可指定返回更多媒资字段', + 'description' => '视频状态。支持获取多个状态的视频，多个状态之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PrepareFail' => '文件异常', + 'UploadFail' => '上传失败', + 'UploadSucc' => '上传完成', + 'Transcoding' => '转码', + 'TranscodeFail' => '转码失败', + 'ProduceFail' => '合成失败', + 'Normal' => '正常', + 'Uploading' => '上传中', + 'Preparing' => '文件生成中', + 'Blocked' => '屏蔽', + 'Checking' => '审核', + ], + 'example' => 'Uploading,Normal', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => 'CreationTime（创建时间）的开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '实体Id', + 'description' => 'CreationTime的结束时间，需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:59:00Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- CreationTime:Desc（默认值）：按创建时间倒序。'."\n" + .'- CreationTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Asc', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '列表页大小。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Total' => [ + 'description' => '符合条件的媒资总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163', + ], + 'MediaList' => [ + 'description' => '媒资信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息列表。', + 'type' => 'object', + 'properties' => [ + 'StorageLocation' => [ + 'description' => '存储地址。', + 'type' => 'string', + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com', + ], + 'Status' => [ + 'description' => '视频状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PrepareFail' => '文件异常', + 'UploadFail' => '上传失败', + 'UploadSucc' => '上传成功', + 'Transcoding' => '转码', + 'TranscodeFail' => '转码失败', + 'ProduceFail' => '合成失败', + 'Normal' => '正常', + 'Uploading' => '上传中', + 'Preparing' => '文件生成中', + 'Blocked' => '屏蔽', + 'Checking' => '审核', + ], + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3679', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '1c6ce34007d571ed94667630a6bc****', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'string', + 'example' => '标签1, 标签2', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:16:50Z', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '分类1', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => '阿里云VOD视频描述', + ], + 'AppId' => [ + 'description' => '应用ID。默认取值：app-1000000', + 'type' => 'string', + 'example' => 'app-1000000', + ], + 'Size' => [ + 'description' => '源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10897890', + ], + 'CoverUrl' => [ + 'description' => '封面URL。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', + ], + 'Duration' => [ + 'description' => '时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '135.6', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '史上最牛音乐播放器', + ], + 'Snapshots' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Total\\": 163,\\n \\"MediaList\\": [\\n {\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\",\\n \\"CateId\\": 3679,\\n \\"MediaId\\": \\"1c6ce34007d571ed94667630a6bc****\\",\\n \\"Tags\\": \\"标签1, 标签2\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:16:50Z\\",\\n \\"CateName\\": \\"分类1\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"Size\\": 10897890,\\n \\"CoverUrl\\": \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\n \\"Duration\\": 135.6,\\n \\"Title\\": \\"史上最牛音乐播放器\\",\\n \\"Snapshots\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取媒资信息列表', + 'description' => '本接口最多可获取指定筛选条件（如视频状态、分类ID等）的前5000条音视频。建议限定StartTime和EndTime来分批获取数据。', + ], + 'SearchMediaByFace' => [ + 'summary' => '人脸图片搜媒资接口（粗搜），输入一张人脸图片，搜索该人物所在媒资的相关信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '实体Id', + 'description' => '实体ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2d3bf1e35a1e42b5ab338d701efa****', + ], + ], + [ + 'name' => 'PersonImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸图片URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/input/huangxuan****.jpg', + ], + ], + [ + 'name' => 'FaceSearchToken', + 'in' => 'query', + 'schema' => [ + 'description' => '通过该参数判断是同一个搜索条件下的分页返回，与[精搜接口](~~612891~~)里的FaceSearchToken配合使用。', + 'type' => 'string', + 'required' => true, + 'example' => 'zxtest-huangxuan-2023-3-7-V1', + ], + ], + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资类型。取值：'."\n" + .'- image：图片'."\n" + .'- video：视频', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义过滤', + 'description' => '自定义过滤。JOSN字符串；支持字段Int型intField1、字符串型strField1、strField2；同一个字段最多可选择一种匹配，不通字段过滤时是且关系。'."\n" + .'- 精准，如 {"intField1":12,"strField1":"abc"}'."\n" + .'- 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]}'."\n" + .'- 范围，如 {"intField1":{"gte":12,"lte":13}}', + 'type' => 'string', + 'required' => false, + 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', + ], + ], + [ + 'name' => 'UtcCreate', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => '创建时间，毫秒时间戳。gte大于等于，lte小于等于。'."\n" + .'- 范围，如{"gte":1761205662998,"lte":1771205662998}', + 'type' => 'string', + 'required' => false, + 'example' => '{"gte":1761205662998,"lte":1771205662998}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7CA7D615-CFB1-5437-9A12-2D185C3EE6CB', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaInfoList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息列表。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '3b187b3620c8490886cfc2a9578c****', + ], + ], + ], + ], + 'Total' => [ + 'description' => '满足搜索条件的媒资信息总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '163', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CA7D615-CFB1-5437-9A12-2D185C3EE6CB\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaInfoList\\": [\\n {\\n \\"MediaId\\": \\"3b187b3620c8490886cfc2a9578c****\\"\\n }\\n ],\\n \\"Total\\": 163\\n}","type":"json"}]', + 'title' => '人脸图片搜媒资', + 'description' => '阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等，请搜索钉钉群（30415005038）加入智能媒体服务多模检索客户答疑群联系我们。', + ], + 'SearchMediaClipByFace' => [ + 'summary' => '人脸图片搜媒资片段接口（精搜），基于粗搜结果返回该人脸所在媒资的相关人物片段信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '实体Id', + 'description' => '实体ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2d3bf1e35a1e42b5ab338d701efa****', + ], + ], + [ + 'name' => 'FaceSearchToken', + 'in' => 'query', + 'schema' => [ + 'description' => '与[粗搜接口](~~612893~~)里的FaceSearchToken的值保持一致，通过该参数判断是同一个搜索条件下的分页返回。', + 'type' => 'string', + 'required' => true, + 'example' => 'zxtest-huangxuan-2023-3-7-V1', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3b187b3620c8490886cfc2a9578c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E44FFACD-9E90-555A-A09A-6FD3B7335E39', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功，false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaClipList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资片段集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '匹配片段得分，Float类型，范围为[0，1]。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.99041677', + ], + 'EntityId' => [ + 'description' => '实体ID，对应标签分析结果里的实体ID。', + 'type' => 'string', + 'example' => '1031025****', + ], + 'LabelName' => [ + 'description' => '实体名称。', + 'type' => 'string', + 'example' => '张三', + ], + 'OccurrencesInfos' => [ + 'title' => 'FileInfos', + 'description' => '人物片段聚类信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '匹配片段的起始时间，单位为秒，Float类型。', + 'type' => 'number', + 'format' => 'float', + 'example' => '61.066353', + ], + 'EndTime' => [ + 'description' => '匹配片段的结束时间，单位为秒，Float类型。', + 'type' => 'number', + 'format' => 'float', + 'example' => '69.06635', + ], + 'TrackData' => [ + 'description' => '人脸在片段中的具体信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '人脸在媒资中出现的时间戳，单位为秒，Float类型。', + 'type' => 'number', + 'format' => 'float', + 'example' => '62.03302', + ], + 'BoxPosition' => [ + 'description' => '人脸坐标信息。', + 'type' => 'object', + 'properties' => [ + 'X' => [ + 'description' => '左上顶点x轴坐标，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '517', + ], + 'Y' => [ + 'description' => '左上顶点y轴坐标，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '409', + ], + 'W' => [ + 'description' => '矩形框宽度，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '128', + ], + 'H' => [ + 'description' => '矩形框高度，单位为像素。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '168', + ], + ], + ], + ], + ], + ], + 'Expression' => [ + 'description' => '表情。', + 'type' => 'string', + 'example' => '平静', + ], + ], + ], + ], + 'Category' => [ + 'description' => '人物类型。'."\n" + .'取值：'."\n" + .'celebrity——名人'."\n" + .'sensitive——敏感人物'."\n" + .'politician——政治人物'."\n" + .'custom——自定义人物'."\n" + .'unknown——未知人物', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'celebrity', + ], + ], + ], + ], + 'Total' => [ + 'description' => '符合条件的媒资片段总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E44FFACD-9E90-555A-A09A-6FD3B7335E39\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaClipList\\": [\\n {\\n \\"Score\\": 0.99041677,\\n \\"EntityId\\": \\"1031025****\\",\\n \\"LabelName\\": \\"张三\\",\\n \\"OccurrencesInfos\\": [\\n {\\n \\"StartTime\\": 61.066353,\\n \\"EndTime\\": 69.06635,\\n \\"TrackData\\": [\\n {\\n \\"Timestamp\\": 62.03302,\\n \\"BoxPosition\\": {\\n \\"X\\": 517,\\n \\"Y\\": 409,\\n \\"W\\": 128,\\n \\"H\\": 168\\n }\\n }\\n ],\\n \\"Expression\\": \\"平静\\"\\n }\\n ],\\n \\"Category\\": \\"celebrity\\"\\n }\\n ],\\n \\"Total\\": 5\\n}","type":"json"}]', + 'title' => '人脸图片搜媒资片段', + 'description' => '阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等，请搜索钉钉群（30415005038）加入智能媒体服务多模检索客户答疑群联系我们。', + ], + 'SearchMediaByAILabel' => [ + 'summary' => '可以根据人名、字幕、AI分类进行多模搜索。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195892', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库名称', + 'description' => '搜索库名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索结果中返回的媒资字段。 默认只返回基本媒资字段，可指定返回更多媒资字段', + 'description' => '媒资类型。取值：'."\n" + .'- image：图片'."\n" + .'- video：视频'."\n" + .'- audio：音频', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => 'image', + 'video' => 'video', + 'audio' => 'audio', + ], + 'example' => 'video', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段和排序顺序。多个使用英文逗号（,）分隔', + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- CreationTime:Desc（默认值）：按创建时间倒序。'."\n" + .'- CreationTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc'."\n", + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤条件', + 'description' => '搜索内容。', + 'type' => 'string', + 'required' => false, + 'example' => '风筝', + ], + ], + [ + 'name' => 'MultimodalSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '多模搜索类型。默认为全文搜索。取值：'."\n" + ."\n" + .'- PersonName：人名搜'."\n" + .'- Ocr：字幕搜'."\n" + .'- AiCategory ：AI分类'."\n" + .'- FullSearch：全文搜', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PersonName' => 'PersonName', + 'AiCategory' => 'AiCategory', + 'FullSearch' => 'FullSearch', + 'Ocr' => 'Ocr', + ], + 'example' => 'Ocr', + ], + ], + [ + 'name' => 'SpecificSearch', + 'in' => 'query', + 'schema' => [ + 'description' => '是否精搜。取值：'."\n" + ."\n" + .'- true： 精搜'."\n" + .'- false：粗搜', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。精搜时必须携带。', + 'type' => 'string', + 'required' => false, + 'example' => '****c469e944b5a856828dc2****'."\n", + ], + ], + [ + 'name' => 'MatchingMode', + 'in' => 'query', + 'schema' => [ + 'description' => '匹配模式，默认为fuzzy模糊匹配。取值：'."\n" + ."\n" + .'- fuzzy： 模糊'."\n" + .'- precise：精确，该模式仅对新增媒资生效。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'precise' => 'precise', + 'fuzzy' => 'fuzzy', + ], + 'example' => 'fuzzy', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义过滤', + 'description' => '自定义过滤。JOSN字符串；支持字段Int型intField1、字符串型strField1、strField2；同一个字段最多可选择一种匹配，不通字段过滤时是且关系。'."\n" + .'- 精准，如 {"intField1":12,"strField1":"abc"}'."\n" + .'- 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]}'."\n" + .'- 范围，如 {"intField1":{"gte":12,"lte":13}}', + 'type' => 'string', + 'required' => false, + 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', + ], + ], + [ + 'name' => 'UtcCreate', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => '创建时间，毫秒时间戳。gte大于等于，lte小于等于。'."\n" + .'- 范围，如{"gte":1761205662998,"lte":1771205662998}', + 'type' => 'string', + 'required' => false, + 'example' => '{"gte":1761205662998,"lte":1771205662998}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息详情。', + 'type' => 'object', + 'properties' => [ + 'AiData' => [ + 'description' => 'AI详细信息。', + 'type' => 'object', + 'properties' => [ + 'AiLabelInfo' => [ + 'description' => 'AI标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AI标签信息。', + 'type' => 'object', + 'properties' => [ + 'FaceId' => [ + 'description' => '人脸ID。', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", + ], + 'LabelType' => [ + 'description' => '标签类型。', + 'type' => 'string', + 'example' => '物体', + ], + 'Source' => [ + 'description' => '来源。', + 'type' => 'string', + 'example' => 'vision', + ], + 'Category' => [ + 'description' => '分类。', + 'type' => 'string', + 'example' => '交通工具', + ], + 'LabelName' => [ + 'description' => '实体名称。', + 'type' => 'string', + 'example' => '车', + ], + 'LabelId' => [ + 'description' => '实体ID。', + 'type' => 'string', + 'example' => '103102503**', + ], + 'Occurrences' => [ + 'description' => '片段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '片段。', + 'type' => 'object', + 'properties' => [ + 'Score' => [ + 'description' => '打分。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.75287705'."\n", + ], + 'Image' => [ + 'description' => '最优人脸图片。', + 'type' => 'string', + 'example' => 'https://service-****-public.oss-cn-hangzhou.aliyuncs.com/1563457****438522/service-image/f788974f-9595-43b2-a478-7c7a1afb****.jpg', + ], + 'TableBatchSeqId' => [ + 'description' => '向量表序列ID。', + 'type' => 'string', + 'example' => '85010D1**', + ], + 'ClipId' => [ + 'description' => '片段ID。', + 'type' => 'string', + 'example' => '158730355E4B82257D8AA1583A58****', + ], + 'From' => [ + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'FinegrainName' => [ + 'description' => '实体的细粒度名称。', + 'type' => 'string', + 'example' => '车', + ], + 'FinegrainId' => [ + 'description' => '实体的细粒度ID。', + 'type' => 'string', + 'example' => '103102503**', + ], + 'Content' => [ + 'description' => '文本内容。', + 'type' => 'string', + 'example' => '智能标签测试'."\n", + ], + 'Tracks' => [ + 'description' => 'track序列。', + 'type' => 'array', + 'items' => [ + 'description' => '序列。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '人脸bbox框的面积。', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + 'Position' => [ + 'description' => 'bbox框位置坐标。', + 'type' => 'string', + 'example' => '468.0;67.0;615.0;267.0', + ], + 'Timestamp' => [ + 'description' => 'track的时间戳。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'AsrInfo' => [ + 'description' => '语音信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '语音信息。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'ClipId' => [ + 'description' => '片段ID。', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****', + ], + 'Content' => [ + 'description' => '文本内容。', + 'type' => 'string', + 'example' => '智能标签测试', + ], + 'Timestamp' => [ + 'description' => '片段时间戳。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + 'OcrInfo' => [ + 'description' => '字幕信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕信息。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + 'To' => [ + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.5', + ], + 'ClipId' => [ + 'description' => '片段ID。', + 'type' => 'string', + 'example' => '5FE19530C7A422197535FE74F5DB****'."\n", + ], + 'Content' => [ + 'description' => '文本内容。', + 'type' => 'string', + 'example' => '皮皮', + ], + 'Timestamp' => [ + 'description' => '片段时间戳。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.4', + ], + ], + ], + ], + ], + ], + 'StorageLocation' => [ + 'description' => '存储地址。', + 'type' => 'string', + 'example' => 'out-****.oss-cn-shanghai.aliyuncs.com'."\n", + ], + 'Status' => [ + 'description' => '视频状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PrepareFail' => 'PrepareFail', + 'UploadFail' => 'UploadFail', + 'Init' => 'Init', + 'UploadSucc' => 'UploadSucc', + 'Transcoding' => 'Transcoding', + 'TranscodeFail' => 'TranscodeFail', + 'Deleted' => 'Deleted', + 'Normal' => 'Normal', + 'Uploading' => 'Uploading', + 'Preparing' => 'Preparing', + 'Blocked' => 'Blocked', + 'Checking' => 'Checking', + ], + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z'."\n", + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2017-11-14T09:15:50Z'."\n", + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '1c6ce34007d571ed94667630a6bc****'."\n", + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'string', + 'example' => '标签1, 标签2'."\n", + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => '阿里云VOD视频描述'."\n", + ], + 'AppId' => [ + 'description' => '应用ID。默认取值：app-1000000。', + 'type' => 'string', + 'example' => 'app-1000000', + ], + 'Size' => [ + 'description' => '源文件大小。单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10897890', + ], + 'CoverUrl' => [ + 'description' => '封面URL。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', + ], + 'Duration' => [ + 'description' => '时长（单位：秒）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '12.2', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '史上最牛音乐播放器'."\n", + ], + 'Snapshots' => [ + 'description' => '视频截图URL数组。', + 'type' => 'array', + 'items' => [ + 'description' => '视频截图URL。', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****', + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '符合条件的媒资总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"AiData\\": {\\n \\"AiLabelInfo\\": [\\n {\\n \\"FaceId\\": \\"5FE19530C7A422197535FE74F5DB****\\\\n\\",\\n \\"LabelType\\": \\"物体\\",\\n \\"Source\\": \\"vision\\",\\n \\"Category\\": \\"交通工具\\",\\n \\"LabelName\\": \\"车\\",\\n \\"LabelId\\": \\"103102503**\\",\\n \\"Occurrences\\": [\\n {\\n \\"Score\\": 0.75287705,\\n \\"Image\\": \\"https://service-****-public.oss-cn-hangzhou.aliyuncs.com/1563457****438522/service-image/f788974f-9595-43b2-a478-7c7a1afb****.jpg\\",\\n \\"TableBatchSeqId\\": \\"85010D1**\\",\\n \\"ClipId\\": \\"158730355E4B82257D8AA1583A58****\\",\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"FinegrainName\\": \\"车\\",\\n \\"FinegrainId\\": \\"103102503**\\",\\n \\"Content\\": \\"智能标签测试\\\\n\\",\\n \\"Tracks\\": [\\n {\\n \\"Size\\": 50,\\n \\"Position\\": \\"468.0;67.0;615.0;267.0\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"AsrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\",\\n \\"Content\\": \\"智能标签测试\\",\\n \\"Timestamp\\": 1.4\\n }\\n ],\\n \\"OcrInfo\\": [\\n {\\n \\"From\\": 1.4,\\n \\"To\\": 2.5,\\n \\"ClipId\\": \\"5FE19530C7A422197535FE74F5DB****\\\\n\\",\\n \\"Content\\": \\"皮皮\\",\\n \\"Timestamp\\": 1.4\\n }\\n ]\\n },\\n \\"StorageLocation\\": \\"out-****.oss-cn-shanghai.aliyuncs.com\\\\n\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2017-11-14T09:15:50Z\\\\n\\",\\n \\"ModificationTime\\": \\"2017-11-14T09:15:50Z\\\\n\\",\\n \\"MediaId\\": \\"1c6ce34007d571ed94667630a6bc****\\\\n\\",\\n \\"Tags\\": \\"标签1, 标签2\\\\n\\",\\n \\"Description\\": \\"阿里云VOD视频描述\\\\n\\",\\n \\"AppId\\": \\"app-1000000\\",\\n \\"Size\\": 10897890,\\n \\"CoverUrl\\": \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\",\\n \\"Duration\\": 12.2,\\n \\"Title\\": \\"史上最牛音乐播放器\\\\n\\",\\n \\"Snapshots\\": [\\n \\"http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\\"\\n ]\\n }\\n ],\\n \\"Total\\": 30\\n}","type":"json"}]', + 'title' => '智能标签文本搜索', + 'description' => '可以根据人名、字幕、AI分类进行多模搜索，粗搜支持媒资粒度返回，精搜支持媒资内命中片段信息返回。', + ], + 'SearchMediaByMultimodal' => [ + 'summary' => '大模型搜索。用户可以使用自然语言描述进行搜索。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索结果中返回的媒资类型。', + 'description' => '媒资类型。默认值video。'."\n" + .'- image：图片。'."\n" + .'- video：视频。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => 'image', + 'video' => 'video', + ], + 'example' => 'video', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索内容。', + 'description' => '搜索内容。可以是自然语言描述。', + 'type' => 'string', + 'required' => false, + 'example' => '两只熊猫在打架', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义过滤', + 'description' => '自定义过滤。JOSN字符串；支持字段Int型intField1、字符串型strField1、strField2；同一个字段最多可选择一种匹配，不通字段过滤时是且关系。'."\n" + .'- 精准，如 {"intField1":12,"strField1":"abc"}'."\n" + .'- 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]}'."\n" + .'- 范围，如 {"intField1":{"gte":12,"lte":13}}', + 'type' => 'string', + 'required' => false, + 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', + ], + ], + [ + 'name' => 'UtcCreate', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => '创建时间，毫秒时间戳。gte大于等于，lte小于等于。'."\n" + .'- 范围，如{"gte":1761205662998,"lte":1771205662998}', + 'type' => 'string', + 'required' => false, + 'example' => '{"gte":1761205662998,"lte":1771205662998}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'description' => '媒资信息详情。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => 'a18936e0e28771edb59ae6f6f47a****', + ], + 'ClipInfo' => [ + 'description' => '片段信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'To' => [ + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'Score' => [ + 'description' => '打分。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.99', + ], + ], + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '满足搜索条件的媒资信息总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"MediaId\\": \\"a18936e0e28771edb59ae6f6f47a****\\",\\n \\"ClipInfo\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 4,\\n \\"Score\\": 0.99\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 20\\n}","type":"json"}]', + 'title' => '大模型搜索', + 'description' => '阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等，请搜索钉钉群（30415005038）加入智能媒体服务多模检索客户答疑群联系我们。', + ], + 'SearchMediaByHybrid' => [ + 'summary' => '媒资混合搜索。智能标签文本搜索和大模型搜索能力合并进行多路召回，用户可以使用自然语言描述进行搜索。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224461', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'SearchLibName', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索库', + 'description' => '搜索库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-1', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索结果中返回的媒资类型。', + 'description' => '媒资类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => 'image', + 'video' => 'video', + ], + 'example' => 'video', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1', + 'description' => '当前页码。默认值为1。'."\n" + ."\n" + .'- image：图片。'."\n" + .'- video：视频。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页返回的数据条数。默认值为10，最大值为50', + 'description' => '每页返回的数据条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索内容。', + 'description' => '搜索内容。', + 'type' => 'string', + 'required' => false, + 'example' => '两只熊猫在打架', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。携带时返回媒资命中详细信息。', + 'type' => 'string', + 'required' => false, + 'example' => '****c469e944b5a856828dc2****'."\n", + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-1', + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义过滤', + 'description' => '自定义过滤。JOSN字符串；支持字段Int型intField1、字符串型strField1、strField2；同一个字段最多可选择一种匹配，不通字段过滤时是且关系。'."\n" + .'- 精准，如 {"intField1":12,"strField1":"abc"}'."\n" + .'- 多值，如 {"intField1":[12,13],"strField1":["abc","cd"]}'."\n" + .'- 范围，如 {"intField1":{"gte":12,"lte":13}}', + 'type' => 'string', + 'required' => false, + 'example' => '{"intField1":{"gte":12,"lte":13},"strField2":["cd","de"],"strField1":"abc"}', + ], + ], + [ + 'name' => 'UtcCreate', + 'in' => 'query', + 'schema' => [ + 'title' => '时间', + 'description' => '创建时间，毫秒时间戳。gte大于等于，lte小于等于。'."\n" + .'- 范围，如{"gte":1761205662998,"lte":1771205662998}', + 'type' => 'string', + 'required' => false, + 'example' => '{"gte":1761205662998,"lte":1771205662998}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功，false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'MediaList' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'description' => '符合要求的媒资集合。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => 'a18936e0e28771edb59ae6f6f47a****', + ], + 'ClipInfo' => [ + 'description' => '片段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '片段信息。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '片段起始时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + 'To' => [ + 'description' => '片段结束时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => '4', + ], + 'Score' => [ + 'description' => '打分。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.99', + ], + ], + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '满足搜索条件的媒资信息总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"MediaList\\": [\\n {\\n \\"MediaId\\": \\"a18936e0e28771edb59ae6f6f47a****\\",\\n \\"ClipInfo\\": [\\n {\\n \\"From\\": 2,\\n \\"To\\": 4,\\n \\"Score\\": 0.99\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 30\\n}","type":"json"}]', + 'title' => '混合搜索', + 'description' => '阿里云智能媒体服务智能媒资搜索功能使用或问题咨询等，请搜索钉钉群（30415005038）加入智能媒体服务多模检索客户答疑群联系我们。', + ], + 'RegisterMediaInfo' => [ + 'summary' => '发起一个注册媒资的任务，赋予新媒资一个IMS的mediaId。接口根据InputURL，异步调用其他媒资信息服务，获取媒资的文件信息。同时用户可以设置一些基本信息的值，如标题、标签、描述等。接口同步返回mediaId，用户可以调用获取媒资内容信息GetMediaInfo的接口，获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '6889', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputURL', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资媒体url', + 'description' => '待注册的媒资在相应系统中的地址，一经注册不可更改，并与IMS的mediaId绑定。'."\n" + ."\n" + .'- OSS地址，支持两种格式。'."\n" + .' '."\n" + .'http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" + ."\n" + .'oss://example-bucket/example.mp4'."\n" + .' （此格式默认oss region与服务接入区域一致）'."\n" + ."\n" + .'- VOD媒资'."\n" + ."\n" + .'vod://\\*\\*\\*20b48fb04483915d4f2cd8ac****', + 'type' => 'string', + 'required' => true, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型。取值范围：'."\n" + ."\n" + .'- "image" 图片'."\n" + ."\n" + .'- "video" 视频'."\n" + ."\n" + .'- "audio" 音频'."\n" + ."\n" + .'- "text" 文字'."\n" + ."\n" + .'当取值为"text"时，businessType需对应"subtitles"或"font"。'."\n" + ."\n" + .'此字段建议用户按需填写。当InputURL字段是OSS URL时，也支持按照文件后缀自动判断媒资类型（仅限图片、视频、音频文件后缀），对应关系见[文件格式](~~466207~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。取值范围：'."\n" + ."\n" + .'- "subtitles" 字幕'."\n" + ."\n" + .'- "font" 字体'."\n" + ."\n" + .'- "watermark" 水印'."\n" + ."\n" + .'- "opening" 片头/开场'."\n" + ."\n" + .'- "ending" 片尾'."\n" + ."\n" + .'- "general" 通用', + 'type' => 'string', + 'required' => false, + 'example' => 'opening', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '标题', + 'description' => '标题，若不提供，根据日期自动生成默认title。'."\n" + ."\n" + .'- 长度不超过128字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'defaultTitle', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '内容描述。'."\n" + ."\n" + .'- 长度不超过1024字节'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'defaultDescription', + ], + ], + [ + 'name' => 'MediaTags', + 'in' => 'query', + 'schema' => [ + 'title' => '标签,如果有多个标签用逗号隔开', + 'description' => '标签。'."\n" + ."\n" + .'- 最多不超过16个标签。'."\n" + ."\n" + .'- 多个用逗号分隔。'."\n" + ."\n" + .'- 单个标签不超过32字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag1,tag2', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'title' => '封面图，仅视频媒资有效', + 'description' => '封面地址。'."\n" + ."\n" + .'- 长度不超过128字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户数据，最大1024字节', + 'description' => '用户数据。支持自定义回调地址配置，配置说明可参考[配置剪辑完成时的回调](~~451631~~)'."\n" + ."\n" + .'- 长度不超过1024字节。'."\n" + ."\n" + .'- UTF8编码。'."\n" + ."\n" + .'- Json 格式', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"} 或{"NotifyAddress":"https://xx.xx.xxx"} 或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'Overwrite', + 'in' => 'query', + 'schema' => [ + 'title' => '是否覆盖已有媒资', + 'description' => '是否覆盖已注册媒资，默认false。'."\n" + ."\n" + .'-true，如果inputUrl已注册，删除原有媒资并注册新媒资；'."\n" + ."\n" + .'-false, 如果inputUrl已注册则不予注册新媒资，暂不支持重复的inputUrl。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端token', + 'description' => '客户端token，32位UUID，保证请求幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => '****0311a423d11a5f7dee713535****', + ], + ], + [ + 'name' => 'RegisterConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '注册媒资的配置', + 'description' => '注册配置。'."\n" + ."\n" + .'默认为媒资生成雪碧图，如不需要可以手动设置NeedSprite字段为false。'."\n" + ."\n" + .'默认生成截图，如不需要可以手动设置NeedSnapshot字段为false。'."\n" + ."\n" + .'如需指定封面图时间，需配置CoverConfig，包含字段：'."\n" + .'- StartTime: 封面图位于素材的第几秒，支持四位小数。'."\n" + ."\n" + .'媒资注册后，如需导入自定义搜索库，需配置SearchLibName。如何创建并使用自定义搜索库，详见[自建搜索库的使用流程](~~2796619#dd34d8c740yj9~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "NeedSprite": "false",'."\n" + .' "CoverConfig": {'."\n" + .' "StartTime": 1.0'."\n" + .' },'."\n" + .' "SearchLibName": "test"'."\n" + .'}', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3048', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'required' => false, + 'example' => '******b4fb044839815d4f2cd8******', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。需保证用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + [ + 'name' => 'SmartTagTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能标签模板。取值：'."\n" + .'- S00000101-300080：包含NLP内容理解功能的系统模板'."\n" + .'- S00000103-000001：包含NLP内容理解功能和所有[标签能力](~~2804526#93b27f536airj~~)'."\n" + .'- S00000103-000002：包含所有[标签能力](~~2804526#93b27f536airj~~)，不包含NLP内容理解功能'."\n" + ."\n" + .'标签能力详见：'."\n" + ."\n" + .'配置该字段后，媒资注册完成会自动发起智能标签分析任务，相关计费项请参考 [智能标签标准版计费](~~600262~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'S00000101-300080', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******5A-CAAC-4850-A3AF-B74606******', + ], + 'MediaId' => [ + 'title' => 'ICE媒资ID', + 'description' => 'IMS媒资ID。', + 'type' => 'string', + 'example' => '******b48fb04483915d4f2cd8******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","errorExample":""},{"type":"xml","example":"<RegisterMediaInfoResponse>\\n <RequestId>******5A-CAAC-4850-A3AF-B74606******</RequestId>\\n <MediaId>******b48fb04483915d4f2cd8******</MediaId>\\n</RegisterMediaInfoResponse>","errorExample":""}]', + 'title' => '注册内容库资源', + 'description' => '注册媒资是一个异步任务，一般需要2-3s完成。当注册接口返回mediaId时，可能媒资还没有注册完成，此时调用[GetMediaInfo](~~441155~~)无法获取到媒资的文件信息。', + ], + 'GetMediaInfo' => [ + 'summary' => '根据IMS mediaId或媒资InputURL，获取并返回媒资信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '6890', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IMS媒资ID，若为空，则必须有InputURL。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'InputURL', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的媒资在相应系统中的地址，使用前必须在IMS内容库中注册并与IMS的mediaId绑定'."\n" + ."\n" + .'- OSS地址，支持两种格式'."\n" + ."\n" + .'http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或者'."\n" + ."\n" + .'oss://example-bucket/example.mp4 此格式默认oss region与服务接入区域一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + ], + [ + 'name' => 'OutputType', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值中媒资文件地址的类型：'."\n" + ."\n" + .'- "oss" 返回OSS地址，默认。'."\n" + ."\n" + .'- "cdn" 返回CDN地址。仅当媒资是由vod导入的、且在vod配置了加速域名，才会返回CDN地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdn', + ], + ], + [ + 'name' => 'ReturnDetailedInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '配置对应媒资字段是否返回详细信息，支持字段：'."\n" + .'AiRoughData.StandardSmartTagJob: 如果媒资提交过标签分析，是否返回详细标签结果。'."\n" + .'- 默认false，任务结果以URL形式返回。'."\n" + .'- true，任务结果以文本形式返回。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AiRoughData.StandardSmartTagJob": false} ', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2FDE2411-DB8D-4A9A-875B-275798F14A5E', + ], + 'MediaInfo' => [ + 'description' => '媒资信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => 'BasicInfo', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => 'MediaId', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '被查询的媒资在相应系统中的地址', + 'type' => 'string', + 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => '标题', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => '描述', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => '分类', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => '标签,tag1', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => 'userDataTest', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图', + 'type' => 'string', + 'example' => '['."\n" + .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",'."\n" + .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>",'."\n" + .' "http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>"'."\n" + .']', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:15Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + 'CateId' => [ + 'description' => '分类ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3048', + ], + 'Biz' => [ + 'description' => '媒资所属业务', + 'type' => 'string', + 'example' => 'ICE', + ], + 'UploadSource' => [ + 'description' => '媒资上传来源', + 'type' => 'string', + 'example' => 'general', + ], + 'CateName' => [ + 'description' => '分类名称', + 'type' => 'string', + 'example' => 'cateName', + ], + 'ReferenceId' => [ + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-1234', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfo列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）', + 'type' => 'string', + 'example' => '30611502', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '216.206667', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1132.68', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '960', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '540', + ], + 'CreateTime' => [ + 'description' => '文件创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'ModifiedTime' => [ + 'description' => '文件修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息，一个媒资可能有多条音频流', + 'description' => '音频流信息，一个媒资可能有多条音频流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '音频流序号', + 'description' => '音频流序号', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '1/24000', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'Profile' => [ + 'title' => '编码预置', + 'description' => '编码预置', + 'type' => 'string', + 'example' => 'High', + ], + 'SampleFmt' => [ + 'title' => '采样格式', + 'description' => '采样格式', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率', + 'description' => '采样率', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数', + 'description' => '声道数', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道输出样式', + 'description' => '声道输出样式', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '1/44100', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '16.200998', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '127.794', + ], + 'Fps' => [ + 'title' => '音频帧率', + 'description' => '音频帧率', + 'type' => 'string', + 'example' => '8', + ], + 'NumFrames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '10', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息，一个媒资可能有多条视频流', + 'description' => '视频流信息，一个媒资可能有多条视频流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '视频流序号', + 'description' => '视频流序号', + 'type' => 'string', + 'example' => '0', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'h264', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码预置', + 'description' => '编码预置', + 'type' => 'string', + 'example' => 'High', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '1/48', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => '0x0000', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '960', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '540', + ], + 'HasBFrames' => [ + 'title' => '是否有B帧', + 'description' => '是否有B帧', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '编码信号分辨率比', + 'description' => '编码信号分辨率比', + 'type' => 'string', + 'example' => '0:1', + ], + 'Dar' => [ + 'title' => '编码显示分辨率比', + 'description' => '编码显示分辨率比', + 'type' => 'string', + 'example' => '0:1', + ], + 'PixFmt' => [ + 'title' => '像素格式', + 'description' => '像素格式', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级', + 'description' => '编码等级', + 'type' => 'string', + 'example' => '30', + ], + 'Fps' => [ + 'title' => '视频帧率', + 'description' => '视频帧率', + 'type' => 'string', + 'example' => '24.0', + ], + 'AvgFPS' => [ + 'title' => '平均帧率', + 'description' => '平均帧率', + 'type' => 'string', + 'example' => '24.0', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '1/12288', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0.081706', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '216.206706', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1001.594', + ], + 'NumFrames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '5184', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + 'Rotate' => [ + 'title' => '旋转', + 'description' => '旋转', + 'type' => 'string', + 'example' => '0', + ], + 'Nb_frames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '5184', + ], + ], + ], + ], + 'SubtitleStreamInfoList' => [ + 'title' => '字幕流信息，一个媒资可能有多条字幕流', + 'description' => '字幕流信息，一个媒资可能有多条字幕流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '音频流序号', + 'description' => '字幕流序号', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'srt', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'SubRip Text', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '29.97', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => 'unicode', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => 'unicode', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '30', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + ], + ], + ], + ], + ], + ], + 'AiRoughData' => [ + 'description' => 'AI 分析原始数据', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'AI分析原始结果', + 'type' => 'string', + 'example' => 'https://sample-bucket.cn-shanghai.aliyuncs.com/result.json', + ], + 'Status' => [ + 'description' => 'AI分析状态：'."\n" + .'- Analyzing 分析中'."\n" + .'- AnalyzeSuccess 分析成功'."\n" + .'- AnalyzeFailed 分析失败'."\n" + .'- Saving 入库中 '."\n" + .'- SaveSuccess 入库成功'."\n" + .'- SaveFailed 入库失败 '."\n" + .'- Deleting 删除中'."\n" + .'- DeleteSuccess 删除成功'."\n" + .'- DeleteFailed 删除失败', + 'type' => 'string', + 'example' => 'Analyzing', + ], + 'SaveType' => [ + 'description' => '入库类型，智能分析完成后是否入搜索库。取值：'."\n" + .'- TEXT 文本库', + 'type' => 'string', + 'example' => 'TEXT', + ], + 'AiCategory' => [ + 'description' => 'AI分类，取值：'."\n" + .'- 生活'."\n" + .'- 颜值'."\n" + .'- 萌宠'."\n" + .'- 资讯'."\n" + .'- 广告'."\n" + .'- 环境资源'."\n" + .'- 汽车', + 'type' => 'string', + 'example' => '生活', + ], + 'AiJobId' => [ + 'description' => 'AI任务ID', + 'type' => 'string', + 'example' => '****483915d4f2cd8ac20b48fb04****', + ], + 'StandardSmartTagJob' => [ + 'description' => '标签任务', + 'type' => 'object', + 'properties' => [ + 'AiJobId' => [ + 'description' => 'AI任务ID', + 'type' => 'string', + 'example' => '****483915d4f2cd8ac20b48fb04****', + ], + 'Status' => [ + 'description' => 'AI分析状态：'."\n" + .'- Analyzing 分析中'."\n" + .'- AnalyzeSuccess 分析成功'."\n" + .'- AnalyzeFailed 分析失败', + 'type' => 'string', + 'example' => 'Analyzing', + ], + 'ResultUrl' => [ + 'description' => '标签结果URL。', + 'type' => 'string', + 'example' => 'http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt', + ], + 'Results' => [ + 'description' => '标签识别结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签识别结果', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '分析结果的具体数据，以 JSON 字符串表示。不同 Type 的数据结构详见[Result 参数说明](~~478787#api-detail-40~~)。', + 'type' => 'string', + 'example' => '{"autoChapters": [...]}', + ], + 'Type' => [ + 'description' => '标签识别类型，取值：'."\n" + .'- NLP：NLP 处理结果'."\n" + .'- TextLabel：文本标签'."\n" + .'- VideoLabel：视频标签'."\n" + .'- ASR：语音识别原始结果'."\n" + .'- OCR：文字识别原始结果', + 'type' => 'string', + 'example' => 'NLP', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FDE2411-DB8D-4A9A-875B-275798F14A5E\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"标题\\",\\n \\"Description\\": \\"描述\\",\\n \\"Category\\": \\"分类\\",\\n \\"MediaTags\\": \\"标签,tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Snapshots\\": \\"[\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00001.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\\\\\",\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00002.jpg?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\\\\\",\\\\n \\\\\\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/snapshot-00003.jpg?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\\\\\"\\\\n]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:15Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 3048,\\n \\"Biz\\": \\"ICE\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"CateName\\": \\"cateName\\",\\n \\"ReferenceId\\": \\"123-1234\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/24000\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"Profile\\": \\"High\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Duration\\": \\"16.200998\\",\\n \\"Bitrate\\": \\"127.794\\",\\n \\"Fps\\": \\"8\\",\\n \\"NumFrames\\": \\"10\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1/48\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"30\\",\\n \\"Fps\\": \\"24.0\\",\\n \\"AvgFPS\\": \\"24.0\\",\\n \\"Timebase\\": \\"1/12288\\",\\n \\"StartTime\\": \\"0.081706\\",\\n \\"Duration\\": \\"216.206706\\",\\n \\"Bitrate\\": \\"1001.594\\",\\n \\"NumFrames\\": \\"5184\\",\\n \\"Lang\\": \\"und\\",\\n \\"Rotate\\": \\"0\\",\\n \\"Nb_frames\\": \\"5184\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"srt\\",\\n \\"CodecLongName\\": \\"SubRip Text\\",\\n \\"CodecTimeBase\\": \\"29.97\\",\\n \\"CodecTagString\\": \\"unicode\\",\\n \\"CodecTag\\": \\"unicode\\",\\n \\"Timebase\\": \\"30\\",\\n \\"StartTime\\": \\"0\\",\\n \\"Duration\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n ],\\n \\"AiRoughData\\": {\\n \\"Result\\": \\"https://sample-bucket.cn-shanghai.aliyuncs.com/result.json\\",\\n \\"Status\\": \\"Analyzing\\",\\n \\"SaveType\\": \\"TEXT\\",\\n \\"AiCategory\\": \\"生活\\",\\n \\"AiJobId\\": \\"****483915d4f2cd8ac20b48fb04****\\",\\n \\"StandardSmartTagJob\\": {\\n \\"AiJobId\\": \\"****483915d4f2cd8ac20b48fb04****\\",\\n \\"Status\\": \\"Analyzing\\",\\n \\"ResultUrl\\": \\"http://xx.oss-cn-shanghai.aliyuncs.com/result2.txt\\",\\n \\"Results\\": [\\n {\\n \\"Data\\": \\"{\\\\\\"autoChapters\\\\\\": [...]}\\",\\n \\"Type\\": \\"NLP\\"\\n }\\n ]\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaInfoResponse>\\n <RequestId>2FDE2411-DB8D-4A9A-875B-275798F14A5E</RequestId>\\n <MediaInfo>\\n <MediaId>****20b48fb04483915d4f2cd8ac****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>****20b48fb04483915d4f2cd8ac****</MediaId>\\n <InputURL>https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputURL>\\n <MediaType>video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>标题</Title>\\n <Description>描述</Description>\\n <Category>分类</Category>\\n <MediaTags>标签,tag1</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userDataTest</UserData>\\n <Status>Normal</Status>\\n <CreateTime>2020-12-26T04:11:08Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <DeletedTime>2020-12-26T04:11:15Z</DeletedTime>\\n <SpriteImages>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"32\\",\\"iceJobId\\":\\"******83ec44d58b2069def2e******\\",\\"location\\":\\"oss-cn-shanghai\\",\\"snapshotRegular\\":\\"example/example-{Count}.jpg\\",\\"spriteRegular\\":\\"example/example-{TileCount}.jpg\\",\\"templateId\\":\\"******e438b14ff39293eaec25******\\",\\"tileCount\\":\\"1\\"}]</SpriteImages>\\n <CateId>3048</CateId>\\n <Biz>ICE</Biz>\\n <UploadSource>general</UploadSource>\\n <CateName>cateName</CateName>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>30611502</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>216.206667</Duration>\\n <Bitrate>1132.68</Bitrate>\\n <Width>960</Width>\\n <Height>540</Height>\\n <CreateTime>2020-12-26T04:11:08Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n </FileBasicInfo>\\n <AudioStreamInfoList>\\n <Index>1</Index>\\n <CodecName>aac</CodecName>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <CodecTimeBase>1/24000</CodecTimeBase>\\n <CodecTagString>mp4a</CodecTagString>\\n <CodecTag>0x6134706d</CodecTag>\\n <Profile>High</Profile>\\n <SampleFmt>fltp</SampleFmt>\\n <SampleRate>44100</SampleRate>\\n <Channels>2</Channels>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Timebase>1/44100</Timebase>\\n <StartTime>0.000000</StartTime>\\n <Duration>16.200998</Duration>\\n <Bitrate>127.794</Bitrate>\\n <Fps>8</Fps>\\n <NumFrames>10</NumFrames>\\n <Lang>und</Lang>\\n </AudioStreamInfoList>\\n <VideoStreamInfoList>\\n <Index>0</Index>\\n <CodecName>h264</CodecName>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Profile>High</Profile>\\n <CodecTimeBase>1/48</CodecTimeBase>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n <CodecTag>0x0000</CodecTag>\\n <Width>960</Width>\\n <Height>540</Height>\\n <HasBFrames>2</HasBFrames>\\n <Sar>0:1</Sar>\\n <Dar>0:1</Dar>\\n <PixFmt>yuv420p</PixFmt>\\n <Level>30</Level>\\n <Fps>24.0</Fps>\\n <AvgFPS>24.0</AvgFPS>\\n <Timebase>1/12288</Timebase>\\n <StartTime>0.081706</StartTime>\\n <Duration>216.206706</Duration>\\n <Bitrate>1001.594</Bitrate>\\n <NumFrames>5184</NumFrames>\\n <Lang>und</Lang>\\n <Rotate>0</Rotate>\\n <Nb_frames>5184</Nb_frames>\\n </VideoStreamInfoList>\\n <SubtitleStreamInfoList>\\n <Index>1</Index>\\n <CodecName>srt</CodecName>\\n <CodecLongName>SubRip Text</CodecLongName>\\n <CodecTimeBase>29.97</CodecTimeBase>\\n <CodecTagString>unicode</CodecTagString>\\n <CodecTag>unicode</CodecTag>\\n <Timebase>30</Timebase>\\n <StartTime>0</StartTime>\\n <Duration>1</Duration>\\n <Lang>und</Lang>\\n </SubtitleStreamInfoList>\\n </FileInfoList>\\n </MediaInfo>\\n</GetMediaInfoResponse>","errorExample":""}]', + 'title' => '获取媒资内容信息', + 'description' => 'MediaId不为空时，优先使用MediaId。如果MediaId为空，则InputURL必须非空。', + ], + 'UpdateMediaInfo' => [ + 'summary' => '根据IMS mediaId或媒资InputURL，更新一个媒资的媒资信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资Id', + 'description' => '媒资Id，若为空，则必须有已在IMS内容库中注册过的InputURL。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'InputURL', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资媒体类型', + 'description' => '待注册的媒资在相应系统中的地址，一经注册不可更改，并与IMS的mediaId绑定。'."\n" + ."\n" + .'- OSS地址，支持两种格式：'."\n" + ."\n" + .'1. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4'."\n" + ."\n" + .'1. oss://example-bucket/example.mp4'."\n" + .'此格式默认oss region与服务接入区域一致', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。取值范围：'."\n" + ."\n" + .'- "subtitles" 字幕'."\n" + ."\n" + .'- "watermark" 水印'."\n" + ."\n" + .'- "opening" 片头/开场'."\n" + ."\n" + .'- "ending" 片尾'."\n" + ."\n" + .'- "general" 通用', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '标题', + 'description' => '标题。'."\n" + ."\n" + .'- 长度不超过128字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'defaultTitle', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '内容描述。'."\n" + ."\n" + .'- 长度不超过1024字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'defaultDescription', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'title' => '分类', + 'description' => '分类。'."\n" + .'- 长度不超过64字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'defaultCategory', + ], + ], + [ + 'name' => 'MediaTags', + 'in' => 'query', + 'schema' => [ + 'title' => '标签,如果有多个标签用逗号隔开', + 'description' => '标签。'."\n" + ."\n" + .'- 最多不超过16个标签。'."\n" + ."\n" + .'- 多个用逗号分隔。'."\n" + ."\n" + .'- 单个标签不超过32字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'updateTags1,updateTags2', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'title' => '封面图，仅视频媒资有效', + 'description' => '封面地址。'."\n" + ."\n" + .'- 长度不超过128字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户数据，最大1024字节', + 'description' => '用户数据，最大1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'userData', + ], + ], + [ + 'name' => 'AppendTags', + 'in' => 'query', + 'schema' => [ + 'title' => '是否以append的形式更新Tags字段', + 'description' => '默认为false，取值：'."\n" + .'- appendTags = true，以追加的模式更新MediaTags字段。'."\n" + .'- appendTags = false，以覆盖的模式更新MediaTags字段。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3048', + ], + ], + [ + 'name' => 'ReferenceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。需保证用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => '123-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'title' => 'ICE媒资ID', + 'description' => 'IMS媒资ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMediaInfoResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <MediaId>****20b48fb04483915d4f2cd8ac****</MediaId>\\n</UpdateMediaInfoResponse>","errorExample":""}]', + 'title' => '更新媒体信息', + 'description' => 'MediaId不为空时，优先使用MediaId。如果MediaId为空，则InputURL必须非空。返回请求ID和媒资ID。不支持给定MediaId，修改InputURL。', + ], + 'DeleteMediaInfos' => [ + 'summary' => '批量删除媒资信息，最多一次删20个。MediaIds不为空时，优先使用MediaIds。如果MediaIds为空，则InputURLs必须非空。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'title' => 'ICE 媒资ID', + 'description' => 'IMS 媒资ID'."\n" + .'- 多个用英文逗号分隔。'."\n" + ."\n" + .'若MediaIds 字段为空，则InputURLs字段必须不为空。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****', + ], + ], + [ + 'name' => 'InputURLs', + 'in' => 'query', + 'schema' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待删除的媒资在相应系统中的地址，该地址对应的文件需要先在IMS中注册，多个URL用英文逗号分隔。'."\n" + .'支持两种格式'."\n" + .'1. http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?'."\n" + .'2. OSS://example-bucket/example.mp4? '."\n" + .'此格式默认OSS region与服务接入区域一致', + 'type' => 'string', + 'required' => false, + 'example' => 'http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4? 或者 oss://example-bucket/example.mp4?', + ], + ], + [ + 'name' => 'DeletePhysicalFiles', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除媒资的物理文件。'."\n" + ."\n" + .'若媒资的存储地址是用户自有oss，需对服务角色AliyunICEDefaultRole提前进行授权<props="china">，具体操作请参见[删除录制文件说明（OSS授权管理）](https://help.aliyun.com/zh/ims/user-guide/record?spm=a2c4g.11186623.0.i8#0737d9c437bmn)</props>。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', + ], + 'IgnoredList' => [ + 'title' => '出现获取错误的ID或inputUr', + 'description' => '出现获取错误的ID或InputURL（与用户输入一致）列表。', + 'type' => 'array', + 'items' => [ + 'description' => '出现获取错误的ID或InputURL（与用户输入一致）。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + 'ForbiddenList' => [ + 'description' => '不可删除的媒资ID或URL（与用户输入一致）列表。一般由于无权限导致。', + 'type' => 'array', + 'items' => [ + 'description' => '不可删除的媒资ID或URL（与用户输入一致）。', + 'type' => 'string', + 'example' => '****15d4a4b0448391508f2cb486****'."\n", + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"IgnoredList\\": [\\n \\"****20b48fb04483915d4f2cd8ac****\\"\\n ],\\n \\"ForbiddenList\\": [\\n \\"****15d4a4b0448391508f2cb486****\\\\n\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeleteMediaInfosResponse>\\n <RequestId>0622C702-41BE-467E-AF2E-883D4517962E</RequestId>\\n <IgnoredList>****20b48fb04483915d4f2cd8ac****</IgnoredList>\\n</DeleteMediaInfosResponse>","errorExample":""}]', + 'title' => '删除媒资内容', + ], + 'BatchGetMediaInfos' => [ + 'summary' => '批量获取媒资信息，支持传入多个mediaId。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '所有待查询的媒资ID，以逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '******b48fb04483915d4f2cd8******,******c48fb37407365d4f2cd8******', + ], + ], + [ + 'name' => 'AdditionType', + 'in' => 'query', + 'schema' => [ + 'description' => '批量查询的媒资额外信息，默认只返回BasicInfo，额外文件信息内容包括：'."\n" + ."\n" + .'\\-FileInfo'."\n" + ."\n" + .'\\-DynamicMetaData', + 'type' => 'string', + 'required' => false, + 'example' => 'FileInfo,DynamicMetaData', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaInfos' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '******c48fb37407365d4f2cd8******', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => '媒资基础信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => 'MediaId', + 'type' => 'string', + 'example' => '******c48fb37407365d4f2cd8******', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址', + 'type' => 'string', + 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型'."\n" + ."\n" + .'\\-Image'."\n" + ."\n" + .'\\-Video'."\n" + ."\n" + .'\\-Audio'."\n" + ."\n" + .'\\-Text', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源'."\n" + ."\n" + .'\\-OSS'."\n" + ."\n" + .'\\-vod', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => '标题', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => '描述', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => '分类', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => '标签,tag1', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => 'userDataTest', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态', + 'type' => 'string', + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:12Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + 'Biz' => [ + 'type' => 'string', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfos', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'example', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）', + 'type' => 'string', + 'example' => '30611502', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '200', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1132.68', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '1080', + ], + ], + ], + ], + ], + ], + 'MediaDynamicInfo' => [ + 'type' => 'object', + 'properties' => [ + 'DynamicMetaData' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'IgnoredList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"******c48fb37407365d4f2cd8******\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"******c48fb37407365d4f2cd8******\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"标题\\",\\n \\"Description\\": \\"描述\\",\\n \\"Category\\": \\"分类\\",\\n \\"MediaTags\\": \\"标签,tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Snapshots\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"3\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******f48f0e4154976b2b8c45******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-beijing\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e6a6440b29eb60bd7c******\\\\\\"}]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:12Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"Biz\\": \\"\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"200\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\"\\n }\\n }\\n ],\\n \\"MediaDynamicInfo\\": {\\n \\"DynamicMetaData\\": {\\n \\"Data\\": \\"\\"\\n }\\n }\\n }\\n ],\\n \\"IgnoredList\\": [\\n \\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<BatchGetMediaInfosResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <MediaInfos>\\n <MediaId>******c48fb37407365d4f2cd8******</MediaId>\\n <MediaBasicInfo>\\n <MediaId>******c48fb37407365d4f2cd8******</MediaId>\\n <InputURL>https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputURL>\\n <MediaType>video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>标题</Title>\\n <Description>描述</Description>\\n <Category>分类</Category>\\n <MediaTags>标签,tag1</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userDataTest</UserData>\\n <Snapshots>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"3\\",\\"iceJobId\\":\\"******f48f0e4154976b2b8c45******\\",\\"location\\":\\"oss-cn-beijing\\",\\"snapshotRegular\\":\\"example.jpg\\",\\"templateId\\":\\"******e6a6440b29eb60bd7c******\\"}]</Snapshots>\\n <Status>Normal</Status>\\n <TranscodeStatus>Init</TranscodeStatus>\\n <CreateTime>2020-12-26T04:11:10Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:12Z</ModifiedTime>\\n <DeletedTime>2020-12-26T04:11:10Z</DeletedTime>\\n <SpriteImages>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"32\\",\\"iceJobId\\":\\"******83ec44d58b2069def2e******\\",\\"location\\":\\"oss-cn-shanghai\\",\\"snapshotRegular\\":\\"example/example-{Count}.jpg\\",\\"spriteRegular\\":\\"example/example-{TileCount}.jpg\\",\\"templateId\\":\\"******e438b14ff39293eaec25******\\",\\"tileCount\\":\\"1\\"}]</SpriteImages>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>30611502</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>200</Duration>\\n <Bitrate>1132.68</Bitrate>\\n <Width>1920</Width>\\n <Height>1080</Height>\\n </FileBasicInfo>\\n </FileInfoList>\\n </MediaInfos>\\n</BatchGetMediaInfosResponse>","errorExample":""}]', + 'title' => '批量获取媒体信息', + ], + 'ListMediaBasicInfos' => [ + 'summary' => '根据用户所给参数，返回所有符合条件的媒资的基础信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '创建时间', + 'description' => 'utcCreated（创建时间）的开始时间。'."\n" + ."\n" + .'- 为开区间（大于开始时间）。'."\n" + ."\n" + .'- 日期格式按照ISO8601标准表示，使用UTC时间。格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。例如：2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-20T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'utcCreated的结束时间。'."\n" + ."\n" + .'- 为闭区间（小于等于结束时间）。'."\n" + ."\n" + .'- 日期格式按照ISO8601标准表示，使用UTC时间。格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。例如：2017-01-11T12:00:00Z 表示北京时间2017年1月11日20点0分0秒。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-20T13:00:00Z', + ], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型。取值范围：'."\n" + ."\n" + .'- "image" 图片'."\n" + ."\n" + .'- "video" 视频'."\n" + ."\n" + .'- "audio" 音频'."\n" + ."\n" + .'- "text" 文字', + 'type' => 'string', + 'required' => false, + 'example' => 'video', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。取值范围：'."\n" + ."\n" + .'- "subtitles" 字幕'."\n" + ."\n" + .'- "watermark" 水印'."\n" + ."\n" + .'- "opening" 片头/开场'."\n" + ."\n" + .'- "ending" 片尾'."\n" + ."\n" + .'- "general" 通用', + 'type' => 'string', + 'required' => false, + 'example' => 'opening', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '来源', + 'description' => '来源。'."\n" + ."\n" + .'- "oss" OSS存储'."\n" + ."\n" + .'- "vod" 视频点播'."\n" + ."\n" + .'- "live" 视频直播'."\n" + ."\n" + .'- "general" 其他来源（默认）', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '资源状态', + 'description' => '资源状态。取值范围：'."\n" + ."\n" + .'- Init（初始状态：源文件未就绪）'."\n" + ."\n" + .'- Preparing（源文件准备中：比如上传中或者剪辑合成中）'."\n" + ."\n" + .'- PrepareFail（源文件准备失败：比如获取源文件信息失败）'."\n" + ."\n" + .'- Normal（正常：源文件已就绪）', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '页号', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'required' => false, + 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '5', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序', + 'description' => '根据utcCreated排序, 默认倒序'."\n" + ."\n" + .'- "desc" 倒序'."\n" + ."\n" + .'- "asc" 正序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'IncludeFileBasicInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '返回值中是否包含文件基础信息', + 'description' => '如果为true，返回值中包含文件基础信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID，单个媒资ID支持前缀匹配', + 'description' => '媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => '****019b82e24b37a1c2958dec38****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******B7-7F87-4792-BFE9-63CD21******', + ], + 'TotalCount' => [ + 'title' => '符合要求的媒资总数', + 'description' => '本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'MediaInfos' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '****019b82e24b37a1c2958dec38****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => 'BasicInfo', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '****019b82e24b37a1c2958dec38****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址', + 'type' => 'string', + 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'opening', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => 'title标题', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => 'desc 描述', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => '分类 category', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => 'tags,tags2', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => 'userData', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"3","iceJobId":"******f48f0e4154976b2b8c45******","location":"oss-cn-beijing","snapshotRegular":"example.jpg","templateId":"******e6a6440b29eb60bd7c******"}]', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态', + 'type' => 'string', + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:04Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:07Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:07Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + 'CateId' => [ + 'description' => '分类ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3049', + ], + 'Biz' => [ + 'description' => '媒资所属业务', + 'type' => 'string', + 'example' => 'ICE', + ], + 'UploadSource' => [ + 'description' => '媒资上传来源', + 'type' => 'string', + 'example' => 'general', + ], + 'ReferenceId' => [ + 'description' => '自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。用户维度唯一。', + 'type' => 'string', + 'example' => '123-123', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfos', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）', + 'type' => 'string', + 'example' => '14340962', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '60.00000', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1912.13', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '1280', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '720', + ], + 'CreateTime' => [ + 'description' => '文件创建时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:04Z', + ], + 'ModifiedTime' => [ + 'description' => '文件修改时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:07Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******B7-7F87-4792-BFE9-63CD21******\\",\\n \\"TotalCount\\": 4,\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"opening\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title标题\\",\\n \\"Description\\": \\"desc 描述\\",\\n \\"Category\\": \\"分类 category\\",\\n \\"MediaTags\\": \\"tags,tags2\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"3\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******f48f0e4154976b2b8c45******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-beijing\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e6a6440b29eb60bd7c******\\\\\\"}]\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"DeletedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"CateId\\": 3049,\\n \\"Biz\\": \\"ICE\\",\\n \\"UploadSource\\": \\"general\\",\\n \\"ReferenceId\\": \\"123-123\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"14340962\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"60.00000\\",\\n \\"Bitrate\\": \\"1912.13\\",\\n \\"Width\\": \\"1280\\",\\n \\"Height\\": \\"720\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListMediaBasicInfosResponse>\\n <RequestId>******B7-7F87-4792-BFE9-63CD21******</RequestId>\\n <TotalCount>4</TotalCount>\\n <MediaInfos>\\n <MediaId>****019b82e24b37a1c2958dec38****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>****019b82e24b37a1c2958dec38****</MediaId>\\n <InputURL>https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputURL>\\n <MediaType>video</MediaType>\\n <BusinessType>opening</BusinessType>\\n <Source>oss</Source>\\n <Title>title标题</Title>\\n <Description>desc 描述</Description>\\n <Category>分类 category</Category>\\n <MediaTags>tags,tags2</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userData</UserData>\\n <Snapshots>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"3\\",\\"iceJobId\\":\\"******f48f0e4154976b2b8c45******\\",\\"location\\":\\"oss-cn-beijing\\",\\"snapshotRegular\\":\\"example.jpg\\",\\"templateId\\":\\"******e6a6440b29eb60bd7c******\\"}]</Snapshots>\\n <Status>Normal</Status>\\n <TranscodeStatus>Init</TranscodeStatus>\\n <CreateTime>2021-01-08T16:52:04Z</CreateTime>\\n <ModifiedTime>2021-01-08T16:52:07Z</ModifiedTime>\\n <DeletedTime>2021-01-08T16:52:07Z</DeletedTime>\\n <SpriteImages>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"32\\",\\"iceJobId\\":\\"******83ec44d58b2069def2e******\\",\\"location\\":\\"oss-cn-shanghai\\",\\"snapshotRegular\\":\\"example/example-{Count}.jpg\\",\\"spriteRegular\\":\\"example/example-{TileCount}.jpg\\",\\"templateId\\":\\"******e438b14ff39293eaec25******\\",\\"tileCount\\":\\"1\\"}]</SpriteImages>\\n <CateId>3049</CateId>\\n <Biz>ICE</Biz>\\n <UploadSource>general</UploadSource>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>14340962</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>60.00000</Duration>\\n <Bitrate>1912.13</Bitrate>\\n <Width>1280</Width>\\n <Height>720</Height>\\n <CreateTime>2021-01-08T16:52:04Z</CreateTime>\\n <ModifiedTime>2021-01-08T16:52:07Z</ModifiedTime>\\n </FileBasicInfo>\\n </FileInfoList>\\n </MediaInfos>\\n <NextToken>8EqYpQbZ6Eh7+Zz8DxVYoQ==</NextToken>\\n <MaxResults>2</MaxResults>\\n</ListMediaBasicInfosResponse>","errorExample":""}]', + 'title' => '列出媒资基础信息', + 'description' => '- 如果includeFileBasicInfo字段为真，还会返回源文件基础信息，例如：时长、文件大小。'."\n" + ."\n" + .'- 最多筛选符合条件的前100条。'."\n" + ."\n" + .'- 所有符合条件的媒资需要精确匹配所有非空字段。支持精确匹配的字段有媒资媒体类型、来源、媒资业务类型、分类、资源状态。'."\n" + ."\n" + .'- 当一次性无法返回所有信息时，用户可使用nextToken进行下一轮查询。', + ], + 'ListPublicMediaBasicInfos' => [ + 'summary' => '列出符合条件的公共素材库媒资基础信息，最多筛选出100条。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaTagId', + 'in' => 'query', + 'schema' => [ + 'title' => '标签', + 'description' => '媒资标签，根据此mediaTagId进行匹配,返回所有包含此标签的媒资。取值：'."\n" + .'- sticker（贴纸类型）'."\n" + .' - sticker-atmosphere：气氛'."\n" + .' - sticker-bubble：气泡'."\n" + .' - sticker-cute：可爱'."\n" + .' - sticker-daily：日常'."\n" + .' - sticker-expression：表情'."\n" + .' - sticker-gif：动图'."\n" + .'- bgm（背景音乐类型）'."\n" + .' - bgm-romantic：浪漫'."\n" + .' - bgm-cuisine：美食'."\n" + .' - bgm-chinese-style：国风'."\n" + .' - bgm-upbeat：轻快'."\n" + .' - bgm-dynamic：动感'."\n" + .' - bgm-relaxing：舒缓'."\n" + .' - bgm-quirky：搞怪'."\n" + .' - bgm-beauty：时尚/美妆'."\n" + .'- bgi（背景图片类型）'."\n" + .' - bgi-grad：渐变背景'."\n" + .' - bgi-solid：纯色背景'."\n" + .' - bgi-pic：图片背景', + 'type' => 'string', + 'required' => false, + 'example' => 'sticker-atmosphere', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一次读取的位置', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'required' => false, + 'example' => 'pSa1SQ0wCe5pzVrQ6mWZEw==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '5', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '当前页码。默认值为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'IncludeFileBasicInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '返回值中是否包含文件基础信息', + 'description' => '如果为true，返回值中包含文件基础信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资业务类型。取值范围：'."\n" + ."\n" + .'- sticker：贴纸'."\n" + ."\n" + .'- bgm：背景音乐'."\n" + ."\n" + .'- bgi：背景图片', + 'type' => 'string', + 'required' => false, + 'example' => 'sticker', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******B7-7F87-4792-BFE9-63CD21******', + ], + 'TotalCount' => [ + 'title' => '符合要求的媒资总数', + 'description' => '符合要求的媒资总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'MediaInfos' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****019b82e24b37a1c2958dec38****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => '媒资基础信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '****019b82e24b37a1c2958dec38****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址。', + 'type' => 'string', + 'example' => 'https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型。', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题。', + 'type' => 'string', + 'example' => 'title标题', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类。', + 'type' => 'string', + 'example' => 'video', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'string', + 'example' => 'sticker-daily', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'userData', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图。', + 'type' => 'string', + 'example' => 'null', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态。', + 'type' => 'string', + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间。', + 'type' => 'string', + 'example' => '2021-01-08T16:52:04Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间。', + 'type' => 'string', + 'example' => '2021-01-08T16:52:04Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间。', + 'type' => 'string', + 'example' => '2021-01-08T16:52:04Z', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => '文件信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等。', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）。', + 'type' => 'string', + 'example' => '338990717', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长。', + 'type' => 'string', + 'example' => '10.040000', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率。', + 'type' => 'string', + 'example' => '270112.12', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '1080', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******B7-7F87-4792-BFE9-63CD21******\\",\\n \\"TotalCount\\": 2,\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"InputURL\\": \\"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title标题\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"video\\",\\n \\"MediaTags\\": \\"sticker-daily\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:04Z\\",\\n \\"DeletedTime\\": \\"2021-01-08T16:52:04Z\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"338990717\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"10.040000\\",\\n \\"Bitrate\\": \\"270112.12\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 2\\n}","errorExample":""},{"type":"xml","example":"<ListPublicMediaBasicInfosResponse>\\n <RequestId>B45F83B7-7F87-4792-BFE9-63CD2137CAF0</RequestId>\\n <TotalCount>2</TotalCount>\\n <MediaInfos>\\n <MediaId>****019b82e24b37a1c2958dec38****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>****019b82e24b37a1c2958dec38****</MediaId>\\n <InputURL>https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputURL>\\n <MediaType>video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>title标题</Title>\\n <Description>description</Description>\\n <Category>video</Category>\\n <MediaTags>sticker-daily</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userData</UserData>\\n <Snapshots>null</Snapshots>\\n <Status>Normal</Status>\\n <TranscodeStatus>Init</TranscodeStatus>\\n <CreateTime>2021-01-08T16:52:04Z</CreateTime>\\n <ModifiedTime>2021-01-08T16:52:04Z</ModifiedTime>\\n <DeletedTime>2021-01-08T16:52:04Z</DeletedTime>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>338990717</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>10.040000</Duration>\\n <Bitrate>270112.12</Bitrate>\\n <Width>1920</Width>\\n <Height>1080</Height>\\n </FileBasicInfo>\\n </FileInfoList>\\n </MediaInfos>\\n <NextToken>8EqYpQbZ6Eh7+Zz8DxVYoQ==</NextToken>\\n <MaxResults>2</MaxResults>\\n</ListPublicMediaBasicInfosResponse>","errorExample":""}]', + 'title' => '列出公共素材库媒资基础信息', + ], + 'ListAllPublicMediaTags' => [ + 'summary' => '列出公共素材库媒资的所有标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'required' => false, + 'example' => '"sticker"', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID，用于区分不同种类的公共版权媒资。取值：'."\n" + ."\n" + .'\\- Copyright_Music: 公共版权音乐'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Copyright_Music', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B45F83B7-7F87-4792-BFE9-63CD2137CAF0', + ], + 'MediaTagList' => [ + 'title' => '公共素材库标签列表', + 'description' => '公共素材库标签列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaTagId' => [ + 'title' => '素材标签id', + 'description' => '素材标签id', + 'type' => 'string', + 'example' => 'sticker-gif', + ], + 'MediaTagNameChinese' => [ + 'title' => '素材标签中文名', + 'description' => '素材标签中文名', + 'type' => 'string', + 'example' => 'Gif', + ], + 'MediaTagNameEnglish' => [ + 'title' => '素材标签英文名', + 'description' => '素材标签英文名', + 'type' => 'string', + 'example' => '动图', + ], + 'Options' => [ + 'description' => '选项列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OptionId' => [ + 'description' => '筛选项ID', + 'type' => 'string', + 'example' => 'Angry', + ], + 'OptionEnglishName' => [ + 'description' => '筛选项英文名', + 'type' => 'string', + 'example' => 'Angry', + ], + 'OptionChineseName' => [ + 'description' => '筛选项中文名', + 'type' => 'string', + 'example' => '愤怒', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B45F83B7-7F87-4792-BFE9-63CD2137CAF0\\",\\n \\"MediaTagList\\": [\\n {\\n \\"MediaTagId\\": \\"sticker-gif\\",\\n \\"MediaTagNameChinese\\": \\"Gif\\",\\n \\"MediaTagNameEnglish\\": \\"动图\\",\\n \\"Options\\": [\\n {\\n \\"OptionId\\": \\"Angry\\",\\n \\"OptionEnglishName\\": \\"Angry\\",\\n \\"OptionChineseName\\": \\"愤怒\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAllPublicMediaTagsResponse>\\n <RequestId>B45F83B7-7F87-4792-BFE9-63CD2137CAF0</RequestId>\\n <MediaTagList>\\n <MediaTagId>sticker-gif</MediaTagId>\\n <MediaTagNameChinese>Gif</MediaTagNameChinese>\\n <MediaTagNameEnglish>动图</MediaTagNameEnglish>\\n </MediaTagList>\\n</ListAllPublicMediaTagsResponse>","errorExample":""}]', + 'title' => '列出公共素材库所有标签', + ], + 'SubmitMediaAiAnalysisJob' => [ + 'summary' => '对媒资进行结构化分析，可以对视频进行发言人分析、视频翻译、段落概要等分析。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '231064', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'description' => '输入媒体，仅支持同区域的OSS地址和媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => '{"MediaType":"video","Media":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/your_movie.mp4"}'."\n" + .'或'."\n" + .'{"Type":"Media","Media":"adbf5a778175ee757c34d0eba4******"}', + ], + ], + [ + 'name' => 'AnalysisParams', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资分析参数', + 'type' => 'string', + 'required' => false, + 'example' => '{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":false}}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，Json 格式，长度限制为 512 字节，支持[自定义回调地址配置](~~451631~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"https://xx.com/xx"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'MediaId' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '******b48fb04483915d4f2cd8******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\"\\n}","type":"json"}]', + 'title' => '提交媒资智能结构化分析任务', + 'extraInfo' => '##### Input参数示例： '."\n" + .'**输入为媒资Id:** '."\n" + .'{"Type":"Media","Media":"c90ba1c0425971efac51e7e6c66a6302"}'."\n" + ."\n" + .'**输入为OSS地址：** '."\n" + .'{"MediaType":"video","Media":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}'."\n" + ."\n" + .'**如果是站外url媒资：** '."\n" + .'{"MediaType":"video","Media":"https://xxx/xxx.mp4"}'."\n" + ."\n\n" + .'##### AnalysisParams参数示例：'."\n" + .'**发音人分析：** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":false}} '."\n" + .' '."\n" + .'**翻译：** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":false,"translationEnabled":true,"targetLanguages":"en"}}'."\n" + ."\n" + .'**章节概要：** '."\n" + .'{"nlpParams":{"sourceLanguage":"cn","diarizationEnabled":true,"speakerCount":0,"summarizationEnabled":true,"translationEnabled":false,"autoChaptersEnabled":true,"meetingAssistanceEnabled":true,"summarizationTypes":"Paragraph,Conversational,QuestionsAnswering,MindMap"}}', + ], + 'AddCategory' => [ + 'summary' => '调用AddCategory创建媒资分类。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CateName', + 'in' => 'query', + 'schema' => [ + 'description' => '分类名称。'."\n" + .'- 最多支持64个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '三级子分类', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '分类类型。取值：'."\n" + .'- default（默认值）：音视频/图片分类。 '."\n" + .'- material：短视频素材分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Category' => [ + 'description' => '媒资分类信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分类类型。取值：'."\n" + .'- **default**（默认值）：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'ParentId' => [ + 'description' => '父分类ID。当ParentId参数设置为空或者小于1时，则默认返回值为-1。表示所创建的分类为根目录。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '分类1', + ], + 'CateId' => [ + 'description' => '创建的分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'Level' => [ + 'description' => '分类层级。一级分类层级为**0**，二级分类层级为**1**，三级分类层级为**2**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"ParentId\\": -1,\\n \\"CateName\\": \\"分类1\\",\\n \\"CateId\\": 45,\\n \\"Level\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建分类', + 'description' => '分类最多支持三级分类，每级分类最多支持创建100个子分类', + ], + 'GetCategories' => [ + 'summary' => '调用GetCategories获取指定的分类信息，及其子分类（即下一级分类）的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[IMS控制台](https://ims.console.aliyun.com)，选择 **媒资管理** > **分类管理**查看分类ID。'."\n" + .'- 通过创建分类接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过获取分类接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '33', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，最小值为10，最大值为100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '结果排序方式。取值范围：'."\n" + ."\n" + .'- CreationTime:Desc（默认值）：按创建时间倒序。'."\n" + ."\n" + .'- CreationTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '分类类型。取值：'."\n" + ."\n" + .'- default（默认值）：音视频/图片分类。'."\n" + ."\n" + .'- material：短视频素材分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SubTotal' => [ + 'description' => '子分类总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Category' => [ + 'description' => '媒资分类信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分类类型。取值：'."\n" + .'- **default**（默认值）：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'CateName' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'example' => '一级分类', + ], + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46', + ], + 'Level' => [ + 'description' => '分类层级。一级分类层级为**0**，二级分类层级为**1**，三级分类层级为**2**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'SubCategories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Category' => [ + 'description' => '子分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子分类列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分类类型。取值：'."\n" + .'- **default**（默认值）：音视频/图片分类。'."\n" + .'- **material**：短视频素材分类。', + 'type' => 'string', + 'example' => 'default', + ], + 'CateName' => [ + 'description' => '分类名称。'."\n" + ."\n" + .'- 最多支持64个字节。'."\n" + .'- UTF-8编码。', + 'type' => 'string', + 'example' => '二级子分类', + ], + 'ParentId' => [ + 'description' => '父分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46', + ], + 'CateId' => [ + 'description' => '分类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '129', + ], + 'SubTotal' => [ + 'description' => '子分类总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Level' => [ + 'description' => '分类层级。'."\n" + ."\n" + .'- 一级分类层级为**0**。'."\n" + .'- 二级分类层级为**1**。'."\n" + .'- 三级分类层级为**2**。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SubTotal\\": 100,\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Category\\": {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"一级分类\\",\\n \\"ParentId\\": -1,\\n \\"CateId\\": 46,\\n \\"Level\\": 0\\n },\\n \\"SubCategories\\": {\\n \\"Category\\": [\\n {\\n \\"Type\\": \\"default\\",\\n \\"CateName\\": \\"二级子分类\\",\\n \\"ParentId\\": 46,\\n \\"CateId\\": 129,\\n \\"SubTotal\\": 100,\\n \\"Level\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取分类及子分类', + 'description' => '支持按分类ID和分类类型来查询分类及其子分类的信息。'."\n" + ."\n", + ], + 'UpdateCategory' => [ + 'summary' => '调用UpdateCategory更新媒资分类。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CateName', + 'in' => 'query', + 'schema' => [ + 'description' => '分类名称。', + 'type' => 'string', + 'required' => true, + 'example' => '分类1', + ], + ], + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[IMS控制台](https://ims.console.aliyun.com)，选择 **媒资管理** > **分类管理**查看分类ID。'."\n" + .'- 通过创建分类接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过获取分类接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '43', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\"\\n}","type":"json"}]', + 'title' => '更新分类', + 'description' => '创建媒资分类后，可调用本接口通过分类ID来定位并更新媒资分类的名称。', + ], + 'DeleteCategory' => [ + 'summary' => '调用DeleteCategory删除媒资分类。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CateId', + 'in' => 'query', + 'schema' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[IMS控制台](https://ims.console.aliyun.com)，选择 **媒资管理** > **分类管理**查看分类ID。'."\n" + .'- 通过创建分类接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过获取分类接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '46', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', + 'title' => '删除分类', + 'description' => '此接口会同时删除其子分类（包括二级分类和三级分类），请慎重操作。', + ], + 'AddMediaMarks' => [ + 'summary' => '本接口用于为媒体资源（如视频、音频文件）添加标记信息，便于后续的检索、分析及管理。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => '53afdf003a2171ed9c6a16b5feac6402', + ], + ], + [ + 'name' => 'MediaMarks', + 'in' => 'query', + 'schema' => [ + 'title' => '打标信息', + 'description' => '打标信息，字符串内容需要符合 JSONArray 格式', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "MarkStartTime": "12.1",'."\n" + .' "MarkEndTime": "12.2",'."\n" + .' "MarkTag": "tag-1",'."\n" + .' "MarkContent": "content-1",'."\n" + .' "MarkStatus": "a"'."\n" + .' },{'."\n" + .' "MarkStartTime": "12.3",'."\n" + .' "MarkEndTime": "12.4",'."\n" + .' "MarkTag": "tag-2",'."\n" + .' "MarkContent": "content-2",'."\n" + .' "MarkStatus": "上线"'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', + ], + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '53afdf003a******6a16b5feac6402', + ], + 'MediaMarkIds' => [ + 'title' => '添加的标记Id', + 'description' => '添加的标记Id', + 'type' => 'string', + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'AddMediaMarksFailed', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\",\\n \\"MediaId\\": \\"53afdf003a******6a16b5feac6402\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', + 'title' => '为媒资增加标记信息', + 'requestParamsDescription' => '## MediaMark'."\n" + .'| 名称 | 类型 | 必填 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| MarkId | String | 否 | 点位 Id|'."\n" + .'| MarkStartTime |Float |否 |入点|'."\n" + .'| MarkEndTime| Float |否 |出点|'."\n" + .'| MarkTag| String |否 |自定义 Tag，便于归类|'."\n" + .'| MarkContent |String |否 |点位内容信息|'."\n" + .'| MarkStatus |String |否 |点位状态|', + ], + 'GetMediaMarks' => [ + 'summary' => '该接口允许用户根据指定的点位ID来查询和获取相应的媒体资源标记信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'MediaMarkIds', + 'in' => 'query', + 'schema' => [ + 'description' => '标记ID，支持多值，多值以逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'MediaMarks' => [ + 'title' => 'MediaMarks', + 'description' => '标记信息列表。字符串内容需要符合JSONArray格式。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "MarkStartTime": "12.1",'."\n" + .' "MarkEndTime": "12.2",'."\n" + .' "MarkTag": "tag-1",'."\n" + .' "MarkContent": "content-1",'."\n" + .' "MarkStatus": "a"'."\n" + .' },'."\n" + .' {'."\n" + .' "MarkStartTime": "12.3",'."\n" + .' "MarkEndTime": "12.4",'."\n" + .' "MarkTag": "tag-2",'."\n" + .' "MarkContent": "content-2",'."\n" + .' "MarkStatus": "上线"'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"MediaMarks\\": \\"[\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.1\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.2\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-1\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-1\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"a\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.3\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.4\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-2\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-2\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"上线\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => '按照点位ID获取媒资标记信息', + 'responseParamsDescription' => '## MediaMark'."\n" + .'| 名称 | 类型 | 必填 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| MarkId | String | 否 | 点位 ID|'."\n" + .'| MarkStartTime |Float |否 |入点|'."\n" + .'| MarkEndTime| Float |否 |出点|'."\n" + .'| MarkTag| String |否 |自定义 Tag，便于归类|'."\n" + .'| MarkContent |String |否 |点位内容信息|'."\n" + .'| MarkStatus |String |否 |点位状态|', + ], + 'UpdateMediaMarks' => [ + 'summary' => '修改媒资标记信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => '53afdf003a******6a16b5feac6402', + ], + ], + [ + 'name' => 'MediaMarks', + 'in' => 'query', + 'schema' => [ + 'title' => '打标信息', + 'description' => '打标信息', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "MarkStartTime": "12.1",'."\n" + .' "MarkEndTime": "12.2",'."\n" + .' "MarkTag": "tag-1",'."\n" + .' "MarkContent": "content-1",'."\n" + .' "MarkStatus": "a"'."\n" + .' },'."\n" + .' {'."\n" + .' "MarkStartTime": "12.3",'."\n" + .' "MarkEndTime": "12.4",'."\n" + .' "MarkTag": "tag-2",'."\n" + .' "MarkContent": "content-2",'."\n" + .' "MarkStatus": "上线"'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '53afdf003a******6a16b5feac6402', + ], + 'MediaMarkIds' => [ + 'title' => '添加的标记Id', + 'description' => '修改成功的标记ID', + 'type' => 'string', + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UpdateMediaMarksFailed', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"53afdf003a******6a16b5feac6402\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', + 'title' => '修改媒资标记信息', + 'requestParamsDescription' => '## MediaMark'."\n" + .'| 名称 | 类型 | 必填 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| MarkId | String | 否 | 点位 ID|'."\n" + .'| MarkStartTime |Float |否 |入点|'."\n" + .'| MarkEndTime| Float |否 |出点|'."\n" + .'| MarkTag| String |否 |自定义 Tag，便于归类|'."\n" + .'| MarkContent |String |否 |点位内容信息|'."\n" + .'| MarkStatus |String |否 |点位状态|', + ], + 'DeleteMediaMarks' => [ + 'summary' => '删除媒资的标记信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => '****c469e944b5a856828dc2****', + ], + ], + [ + 'name' => 'MediaMarkIds', + 'in' => 'query', + 'schema' => [ + 'description' => '标记ID，支持多值，多值以逗号分隔。'."\n" + ."\n" + .'如果 MediaMarkIds 为空，默认删除媒资所有的点位信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '****019b82e24b37a1c2958dec38****', + ], + 'MediaMarkIds' => [ + 'title' => 'MediaMarkIds', + 'description' => '删除的点位ID，以逗号分割', + 'type' => 'string', + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"****019b82e24b37a1c2958dec38****\\",\\n \\"MediaMarkIds\\": \\"mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60\\"\\n}","type":"json"}]', + 'title' => '删除媒资的标记信息', + ], + 'ListMediaMarks' => [ + 'summary' => '列出媒资的全部标记信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => '411bed50018971edb60b0764a0ec6***', + ], + ], + [ + 'name' => 'MediaMarkIds', + 'in' => 'query', + 'schema' => [ + 'description' => '标记ID，支持多值，多值以逗号分隔（此入参已废弃）', + 'type' => 'string', + 'required' => false, + 'example' => 'mark-f82d*****4994b0915948ef7e16,mark-3d56d*****4c8fa9ae2a1f9e5d2d60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '******b48fb04483915d4f2cd8******', + ], + 'MediaMarks' => [ + 'title' => 'MediaMarks', + 'description' => '标记信息列表，字符串内容符合 JSONArray 格式', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "MarkStartTime": "12.1",'."\n" + .' "MarkEndTime": "12.2",'."\n" + .' "MarkTag": "tag-1",'."\n" + .' "MarkContent": "content-1",'."\n" + .' "MarkStatus": "a"'."\n" + .' },'."\n" + .' {'."\n" + .' "MarkStartTime": "12.3",'."\n" + .' "MarkEndTime": "12.4",'."\n" + .' "MarkTag": "tag-2",'."\n" + .' "MarkContent": "content-2",'."\n" + .' "MarkStatus": "上线"'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaId\\": \\"******b48fb04483915d4f2cd8******\\",\\n \\"MediaMarks\\": \\"[\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.1\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.2\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-1\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-1\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"a\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"MarkStartTime\\\\\\": \\\\\\"12.3\\\\\\",\\\\n \\\\\\"MarkEndTime\\\\\\": \\\\\\"12.4\\\\\\",\\\\n \\\\\\"MarkTag\\\\\\": \\\\\\"tag-2\\\\\\",\\\\n \\\\\\"MarkContent\\\\\\": \\\\\\"content-2\\\\\\",\\\\n \\\\\\"MarkStatus\\\\\\": \\\\\\"上线\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => '列出媒资的全部标记信息', + 'responseParamsDescription' => '## MediaMark'."\n" + .'| 名称 | 类型 | 必填 | 描述 |'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'| MarkId | String | 否 | 点位 Id|'."\n" + .'| MarkStartTime |Float |否 |入点|'."\n" + .'| MarkEndTime| Float |否 |出点|'."\n" + .'| MarkTag| String |否 |自定义 Tag，便于归类|'."\n" + .'| MarkContent |String |否 |点位内容信息|'."\n" + .'| MarkStatus |String |否 |点位状态|', + ], + 'CreateIpcOrder' => [ + 'summary' => '创建IPC订单，账号粒度共享容量。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd123', + ], + ], + [ + 'name' => 'Capability', + 'in' => 'query', + 'schema' => [ + 'description' => '能力。取值'."\n" + .'- understand 理解，支持300张图片理解/天'."\n" + .'- understand-reid 含reid理解，支持300张图片理解/天'."\n" + .'- search 搜索，支持75次搜索/天'."\n" + .'- understand-search 理解和搜索，支持300张图片理解和75次搜索/天'."\n" + .'- understand-reid-search 含reid理解和搜索，支持300张图片理解和75次搜索/天', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'understand-reid-search' => 'understand-reid-search', + 'search' => 'search', + 'understand-search' => 'understand-search', + 'understand' => 'understand', + 'understand-reid' => 'understand-reid', + ], + 'example' => 'understand', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '周期。取值：'."\n" + .'- month 包月，按30天算'."\n" + .'- quarter 包季，按90天算'."\n" + .'- year 包年，按365天算', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'month' => 'month', + 'year' => 'year', + 'quarter' => 'quarter', + ], + 'example' => 'month', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'PurchaseStatus' => [ + 'description' => '购买状态。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"PurchaseStatus\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => '创建IPC订单', + 'description' => '请确保在使用该接口前，已充分了解[IPC产品的收费方式和价格](~~3004591~~)。', + ], + 'GetIpcDeviceInfo' => [ + 'summary' => '获取IPC设备信息。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd123', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。与StartTime相差不超过180天。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-02-11T12:00:00Z', + ], + ], + [ + 'name' => 'Capability', + 'in' => 'query', + 'schema' => [ + 'description' => '能力。默认understand，取值：'."\n" + .'- understand 理解'."\n" + .'- understand-reid 含reid理解'."\n" + .'- search 搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'understand', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'DeviceInfos' => [ + 'description' => '设备标识信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设备标识信息列表。', + 'type' => 'object', + 'properties' => [ + 'DeviceId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'd123', + ], + 'Capability' => [ + 'description' => '能力。取值：'."\n" + .'- understand 理解'."\n" + .'- understand-reid 含reid理解'."\n" + .'- search 搜索', + 'type' => 'string', + 'example' => 'understand', + ], + 'ExpireTime' => [ + 'description' => '到期时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2017-02-11T12:00:00Z', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DeviceInfos\\": [\\n {\\n \\"DeviceId\\": \\"d123\\",\\n \\"Capability\\": \\"understand\\",\\n \\"ExpireTime\\": \\"2017-02-11T12:00:00Z\\"\\n }\\n ],\\n \\"Total\\": 78\\n}","type":"json"}]', + 'title' => '获取IPC设备信息', + ], + 'QueryIpcQuota' => [ + 'summary' => '查询IPC用量。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceJQ6U8A', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-08T08:52:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。与StartTime相差不超过180天。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-05-09T08:52:00Z', + ], + ], + [ + 'name' => 'Capability', + 'in' => 'query', + 'schema' => [ + 'description' => '能力。默认understand，取值'."\n" + .'- understand 理解'."\n" + .'- understand-reid 含reid理解'."\n" + .'- search 搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'understand', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'IpcQuotaInfos' => [ + 'description' => 'IPC用量信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPC用量信息。', + 'type' => 'object', + 'properties' => [ + 'Capability' => [ + 'description' => '能力。取值：'."\n" + .'- understand 理解'."\n" + .'- understand-reid 含reid理解'."\n" + .'- search 搜索', + 'type' => 'string', + 'example' => 'understand', + ], + 'DateTime' => [ + 'description' => '对应时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'example' => '2025-12-21T16:00:00Z', + ], + 'MaxQuota' => [ + 'description' => '最大可使用额度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ConsumedQuota' => [ + 'description' => '已消耗额度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '39', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IpcQuotaInfos\\": [\\n {\\n \\"Capability\\": \\"understand\\",\\n \\"DateTime\\": \\"2025-12-21T16:00:00Z\\",\\n \\"MaxQuota\\": 10000,\\n \\"ConsumedQuota\\": 32\\n }\\n ],\\n \\"Total\\": \\"39\\"\\n}","type":"json"}]', + 'title' => '查询IPC用量', + ], + 'GetPlayInfo' => [ + 'summary' => '本接口通过音视频ID直接获取媒体文件（支持视频和音频）的播放地址。集成阿里云播放器SDK（适用于URL播放方式）或第三方播放器后，可使用该地址进行音视频播放。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFUMQ35', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。'."\n" + .'> '."\n" + .'> MediaId和InputURL字段中至少一个不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => '86434e152b7d4f20be480574439fe***', + ], + ], + [ + 'name' => 'InputURL', + 'in' => 'query', + 'schema' => [ + 'description' => '注册媒资时填写的InputURL，详情见[RegisterMediaInfo](~~441152~~)。'."\n" + .'> '."\n" + .'> MediaId和InputURL字段中至少一个不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'AuthTimeout', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaBase' => [ + 'description' => '媒资信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2021-09-22T10:07:31+08:00', + ], + 'Status' => [ + 'description' => '资源状态。取值范围：'."\n" + ."\n" + .'- Init（初始状态：源文件未就绪）'."\n" + ."\n" + .'- Preparing（源文件准备中：比如上传中或者剪辑合成中）'."\n" + ."\n" + .'- PrepareFail（源文件准备失败：比如获取源文件信息失败）'."\n" + ."\n" + .'- Normal（正常：源文件已就绪）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'MediaId' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '2eea77a61c7b4ddd95bec34a6f65b***', + ], + 'CoverURL' => [ + 'description' => '封面URL。', + 'type' => 'string', + 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => 'testTitle', + ], + 'MediaType' => [ + 'description' => '媒体文件类型，取值：'."\n" + ."\n" + .'video：视频。'."\n" + .'audio：纯音频。', + 'type' => 'string', + 'example' => 'video', + ], + 'MediaTags' => [ + 'description' => '标签。'."\n" + ."\n" + .'- 最多不超过16个标签。'."\n" + ."\n" + .'- 多个用逗号分隔。'."\n" + ."\n" + .'- 单个标签不超过32字节。'."\n" + ."\n" + .'- UTF8编码。', + 'type' => 'string', + 'example' => 'test,ccc', + ], + 'CateId' => [ + 'description' => '分类ID。可通过以下方式获取：'."\n" + .'- 登录[IMS控制台](https://ims.console.aliyun.com)，选择 **媒资管理** > **分类管理**查看分类ID。'."\n" + .'- 通过创建分类接口创建分类时，分类ID为返回参数CateId的值。'."\n" + .'- 通过获取分类接口查询分类时，为请求后返回参数CateId的值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4220', + ], + 'Description' => [ + 'description' => '内容描述', + 'type' => 'string', + 'example' => 'desc', + ], + ], + ], + 'PlayInfoList' => [ + 'description' => '音/视频播放信息（流信息）。', + 'type' => 'array', + 'items' => [ + 'description' => '音/视频详细信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-05-10T02:28:49Z', + ], + 'Status' => [ + 'description' => '媒体流状态，取值：'."\n" + ."\n" + .'- **Normal**：正常。'."\n" + .'- **Invisible**：不可见。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'NarrowBandType' => [ + 'description' => '窄带高清类型。取值：'."\n" + ."\n" + .'- **0**：普通。'."\n" + .'- **1.0**：窄带高清1.0。'."\n" + .'- **2.0**：窄带高清2.0。'."\n" + ."\n" + .'仅当配置了窄带高清1.0内置转码模板的清晰度时才会生效。更多详情，请参见[转码模板配置-Definition](~~52839~~)。', + 'type' => 'string', + 'example' => '0', + ], + 'Height' => [ + 'description' => '媒体流高度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1080', + ], + 'Bitrate' => [ + 'description' => '媒体流码率。单位：Kbps。', + 'type' => 'string', + 'example' => '20', + ], + 'ModificationTime' => [ + 'description' => '更新时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'example' => '2022-05-13T11:39:41.714+08:00', + ], + 'WatermarkId' => [ + 'description' => '当前媒体流关联的水印ID。', + 'type' => 'string', + 'example' => '5bed88672b1e2520ead228935ed51***', + ], + 'Encrypt' => [ + 'description' => '媒体流是否加密流，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Definition' => [ + 'description' => '视频流清晰度定义。取值：'."\n" + ."\n" + .'- **FD**：流畅。'."\n" + .'- **LD**：标清。'."\n" + .'- **SD**：高清。'."\n" + .'- **HD**：超清'."\n" + .'- **OD**：原画。'."\n" + .'- **2K**：2K。'."\n" + .'- **4K**：4K。'."\n" + .'- **SQ**：普通音质。'."\n" + .'- **HQ**：高音质。'."\n" + .'- **AUTO**：自适应码率。', + 'type' => 'string', + 'example' => 'HD', + ], + 'EncryptType' => [ + 'description' => '媒体流加密类型。取值：'."\n" + ."\n" + .'- **AliyunVoDEncryption**：阿里云视频加密。'."\n" + .'- **HLSEncryption**：HLS标准加密。'."\n" + ."\n" + .'> 如果加密类型为**AliyunVoDEncryption**，则只能使用阿里云播放器SDK才能正常播放。', + 'type' => 'string', + 'example' => 'AliyunVoDEncryption', + ], + 'StreamType' => [ + 'description' => '媒体流类型。'."\n" + .'若媒体流为视频则取值：**video**，若是纯音频则取值：**audio**。', + 'type' => 'string', + 'example' => 'video', + ], + 'Size' => [ + 'description' => '媒体流大小。单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '418112', + ], + 'Width' => [ + 'description' => '媒体流宽度。单位：px。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Fps' => [ + 'description' => '媒体流帧率。单位：帧/每秒。', + 'type' => 'string', + 'example' => '25', + ], + 'Duration' => [ + 'description' => '媒体流长度。单位：秒。', + 'type' => 'string', + 'example' => '9.0464', + ], + 'PlayURL' => [ + 'description' => '视频流的播放地址。', + 'type' => 'string', + 'example' => 'https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4', + ], + 'Format' => [ + 'description' => '媒体流格式。'."\n" + .'- 若媒体文件为视频则取值： **mp4**、 **m3u8**。'."\n" + .'- 若是纯音频则取值：**mp3**。', + 'type' => 'string', + 'example' => 'mp4', + ], + 'HDRType' => [ + 'title' => '视频流HDR类型', + 'description' => '媒体流HDR类型。取值：'."\n" + .'- HDR'."\n" + .'- HDR10'."\n" + .'- HLG'."\n" + .'- DolbyVision'."\n" + .'- HDRVivid'."\n" + .'- SDR+', + 'type' => 'string', + 'example' => 'HDR', + ], + 'BitDepth' => [ + 'title' => '颜色位深', + 'description' => '颜色位深。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'FileURL' => [ + 'description' => '文件OSS地址。', + 'type' => 'string', + 'example' => 'http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg', + ], + 'TransTemplateType' => [ + 'description' => '转码模板类型，取值：'."\n" + .'- Normal：普通模板'."\n" + .'- AudioTranscode：音频转码'."\n" + .'- Remux：转封装'."\n" + .'- NarrowBandV1：窄带高清1.0'."\n" + .'- NarrowBandV2：窄带高清2.0'."\n" + .'- UHD：音画增强（超高清）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'StreamTags' => [ + 'description' => '流标签，用于标识转码处理类型。', + 'type' => 'string', + 'example' => '"{\\"ims.audioServiceType\\": \\"AudioEnhancement\\"}"', + ], + 'JobId' => [ + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => '36c9d38e70bf43ed9f7f8f48d6356***', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaBase\\": {\\n \\"CreationTime\\": \\"2021-09-22T10:07:31+08:00\\",\\n \\"Status\\": \\"Normal\\",\\n \\"MediaId\\": \\"2eea77a61c7b4ddd95bec34a6f65b***\\",\\n \\"CoverURL\\": \\"https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg\\",\\n \\"Title\\": \\"testTitle\\",\\n \\"MediaType\\": \\"video\\",\\n \\"MediaTags\\": \\"test,ccc\\",\\n \\"CateId\\": 4220,\\n \\"Description\\": \\"desc\\"\\n },\\n \\"PlayInfoList\\": [\\n {\\n \\"CreationTime\\": \\"2022-05-10T02:28:49Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"NarrowBandType\\": \\"0\\",\\n \\"Height\\": 1080,\\n \\"Bitrate\\": \\"20\\",\\n \\"ModificationTime\\": \\"2022-05-13T11:39:41.714+08:00\\",\\n \\"WatermarkId\\": \\"5bed88672b1e2520ead228935ed51***\\",\\n \\"Encrypt\\": 0,\\n \\"Definition\\": \\"HD\\",\\n \\"EncryptType\\": \\"AliyunVoDEncryption\\",\\n \\"StreamType\\": \\"video\\",\\n \\"Size\\": 418112,\\n \\"Width\\": 1024,\\n \\"Fps\\": \\"25\\",\\n \\"Duration\\": \\"9.0464\\",\\n \\"PlayURL\\": \\"https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4\\",\\n \\"Format\\": \\"mp4\\",\\n \\"HDRType\\": \\"HDR\\",\\n \\"BitDepth\\": 8,\\n \\"FileURL\\": \\"http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg\\",\\n \\"TransTemplateType\\": \\"Normal\\",\\n \\"StreamTags\\": \\"\\\\\\"{\\\\\\\\\\\\\\"ims.audioServiceType\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"AudioEnhancement\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"JobId\\": \\"36c9d38e70bf43ed9f7f8f48d6356***\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取音视频播放地址', + ], + 'DeletePlayInfo' => [ + 'summary' => '调用本接口删除媒体流（视频流，音频流）信息。支持批量删除媒体流信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1d3518e0027d71ed80cd909598416303', + ], + ], + [ + 'name' => 'FileURLs', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的播放流文件URL，多个URL用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4', + ], + ], + [ + 'name' => 'DeletePhysicalFiles', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除媒体流的物理文件。'."\n" + .'若媒资的存储地址是用户自有oss，需对服务角色AliyunICEDefaultRole提前进行授权<props="china">，具体操作请参见[OSS授权管理](~~607144#0737d9c037zyp~~)</props>。'."\n" + ."\n" + .'><notice>仅支持删除转码流的物理文件，删除源文件的物理文件暂不支持。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'IgnoredList' => [ + 'description' => '出现获取错误的媒体流URL列表，一般由于媒资ID不存在或媒资流URL不存在导致。', + 'type' => 'array', + 'items' => [ + 'description' => '出现获取错误的媒体流URL。', + 'type' => 'string', + 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4'."\n", + ], + ], + 'ForbiddenList' => [ + 'description' => '不可删除的媒体流URL列表。一般由于无权限导致。', + 'type' => 'array', + 'items' => [ + 'description' => '不可删除的媒体流URL。', + 'type' => 'string', + 'example' => 'https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4'."\n", + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4\\\\n\\"\\n ],\\n \\"ForbiddenList\\": [\\n \\"https://ice-test001.oss-cn-shanghai.aliyuncs.com/%E6%8E%A5%E5%8F%A3%E6%B5%8B%E8%AF%95/%E5%B0%8F%E7%8C%AA%E4%BD%A9%E5%A5%87640*360.mp4\\\\n\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除媒体流', + ], + 'CreateAudit' => [ + 'summary' => '调用CreateAudit针对媒资提交人工审核。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AuditContent', + 'in' => 'query', + 'schema' => [ + 'description' => '审核内容数组。一次最多支持20个视频的审核内容。需将数组转为字符串后作为参数值。 具体参数结构定义，参见下表AuditContent。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '['."\n" + .' {'."\n" + .' "MediaId": "93ab850b4f*****b54b6e91d24d81d4",'."\n" + .' "Status": "Normal"'."\n" + .' },'."\n" + .' {'."\n" + .' "MediaId": "f867fbfb58*****8bbab65c4480ae1d",'."\n" + .' "Status": "Blocked",'."\n" + .' "Reason": "xxxx",'."\n" + .' "Comment": "xxxx"'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '人工审核', + 'requestParamsDescription' => '## 审核内容AuditContent'."\n" + ."\n" + .'|名称 |类型 |必填项 |描述|'."\n" + .'| ------------- |------------ | ----- | ------ |'."\n" + .'|MediaId |String |是 |音/视频ID。|'."\n" + .'|Status |String |是 |音/视频审核状态。取值范围：**Blocked**（屏蔽），**Normal**（正常）。|'."\n" + .'|Reason |String |否 |若审核状态为屏蔽时，需给出屏蔽的理由。最长支持128字节。|'."\n" + .'|Comment|String |否 |审核备注。最长支持512字节。|', + ], + 'SubmitMediaCensorJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '统一模板ID，为空使用默认模板进行审核。', + 'type' => 'string', + 'required' => false, + 'example' => 'S00000001-100060', + ], + ], + [ + 'name' => 'CoverImages', + 'in' => 'query', + 'schema' => [ + 'description' => '封面图片的OSS文件，最多支持5个封面图片，JSON数组。'."\n" + ."\n" + .'> 如果设置，会优先使用这个字段中的封面代替**Media**中的封面。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg","RoleArn":"acs:ram::1997018457688683:role/AliyunICEDefaultRole"}]', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '视频标题，最大长度64个字节。'."\n" + ."\n" + .'> 如果设置，会优先使用这个字段中的标题代替Media中的标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello World', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '视频介绍，最大长度128个字节。'."\n" + ."\n" + .'> 如果设置，会优先使用这个字段中的描述代替Media中的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'example description', + ], + ], + [ + 'name' => 'Barrages', + 'in' => 'query', + 'schema' => [ + 'description' => '视频弹幕。'."\n" + ."\n" + .'> 如果设置，会优先使用这个字段中的描述代替Media中的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello world', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'schema' => [ + 'description' => '截图输出。审核任务会在文件输入文件对应的path下面生成审核截图和结果JSON文件。'."\n" + ."\n" + .'- 输出格式参考：oss://bucket/snapshot-{Count}.jpg，其中，bucket为和当前项目处于同一区域的oss bucket名称，{Count}为截帧图片序号替换符。'."\n" + ."\n" + .'- 审核结果详细信息保存在Output相同OSS文件夹下，命名为{jobId}.output，output文件具体字段格式，请参见[媒体审核结果文件字段](~~609211~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'oss://sashimi-cn-shanghai/censor/snapshot-{Count}.jpg', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度128个字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'UserDatatestid-001-****', + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'Callback路径，支持MNS和HTTP回调。', + 'type' => 'string', + 'required' => false, + 'example' => 'mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入待审核文件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型：'."\n" + ."\n" + .'OSS：OSS路径'."\n" + ."\n" + .'Media：媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '1b1b9cd148034739af413150fded****', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度配置。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5246b8d12a62433ab77845074039****', + ], + 'Priority' => [ + 'description' => '任务优先级。数值越大优先级越高，取值范围：1~10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => '视频审核作业ID。建议您保存此ID便于后续调用其他接口时使用。', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', + 'title' => '提交媒体审核作业', + 'summary' => '允许用户想智能媒体服务提交一个媒体文件的审核任务，该接口支持对视频、音频或图像内容进行自动化的审核，以检测其中可能包含的违规、敏感或不适宜的内容。', + 'description' => '本接口提交的作业是异步执行方式，作业添加到管道中调度排队和执行。可以调用[查询媒体审核作业接口](~~444847~~)查询作业执行结果，也可以使用异步的消息通知机制。', + ], + 'QueryMediaCensorJobDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体审核作业ID。可以从[提交媒体审核作业](~~444848~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大返回数。'."\n" + ."\n" + .'- 默认值：**30**'."\n" + ."\n" + .'- 取值范围：**1~300**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA', + ], + 'MediaCensorJobDetail' => [ + 'description' => '媒体审核作业结果列表。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2018-09-13T16:32:24Z', + ], + 'FinishTime' => [ + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2018-09-13T16:38:24Z', + ], + 'Suggestion' => [ + 'description' => '作业整体审核结果。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + ."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截'."\n" + ."\n" + .'> 任何一种类型的审核结果是review时，整体结果为review，任何一种类型的审核结果是block时，整体结果为block。', + 'type' => 'string', + 'example' => 'block', + ], + 'CoverImageCensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CoverImageCensorResult' => [ + 'description' => '封面审核结果。', + 'type' => 'array', + 'items' => [ + 'description' => '结果详细信息。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '视频封面OSS Object。', + 'type' => 'string', + 'example' => 'test/ai/censor/v2/vme-****.jpg', + ], + 'Location' => [ + 'description' => '视频封面OSS Location。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => '视频封面OSS Bucket。', + 'type' => 'string', + 'example' => 'bucket-out-test-****', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => '审核结果。', + 'type' => 'array', + 'items' => [ + 'description' => '审核结果详细信息。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + .'- 图片智能鉴黄（porn）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **sexy：性感**'."\n" + .' - **porn：色情**'."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **bloody：血腥**'."\n" + .' - **explosion：爆炸烟光**'."\n" + .' - **outfit：特殊装束**'."\n" + .' - **logo：特殊标识**'."\n" + .' - **weapon：武器**'."\n" + .' - **politics：涉政**'."\n" + .' - **violence ：打斗**'."\n" + .' - **crowd：聚众**'."\n" + .' - **parade：游行**'."\n" + .' - **carcrash：车祸现场**'."\n" + .' - **flag：旗帜**'."\n" + .' - **location：地标**'."\n" + .' - **others：其他**'."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **ad：其他广告**'."\n" + .' - **politics：文字含涉政内容**'."\n" + .' - **porn：文字含涉黄内容**'."\n" + .' - **abuse：文字含辱骂内容**'."\n" + .' - **terrorism：文字含暴恐内容**'."\n" + .' - **contraband：文字含违禁内容**'."\n" + .' - **spam：文字含其他垃圾内容**'."\n" + .' - **npx：牛皮癣广告**'."\n" + .' - **qrcode：含二维码**'."\n" + .' - **programCode：含小程序码**'."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **meaningless：图片中无内容（例如黑屏、白屏）**'."\n" + .' - **PIP：画中画**'."\n" + .' - **smoking：吸烟**'."\n" + .' - **drivelive：车内直播**'."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **TV：含受管控的logo**'."\n" + .' - **trademark：含商标**', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄'."\n" + .'- **terrorism**：暴恐涉政'."\n" + .'- **ad**：图文违规'."\n" + .'- **live**：不良场景'."\n" + .'- **logo**：图片Logo', + 'type' => 'string', + 'example' => 'Antispam', + ], + 'Rate' => [ + 'description' => '分值。取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => '作业状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TitleCensorResult' => [ + 'description' => '标题审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值： **antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。', + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'Message' => [ + 'description' => '作业失败时错误信息。执行成功时不返回此参数。', + 'type' => 'string', + 'example' => 'The resource operated cannot be found', + ], + 'Input' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '输入文件的OSS Object。', + 'type' => 'string', + 'example' => 'test/ai/censor/test-****.mp4', + ], + 'Location' => [ + 'description' => '输入文件的OSS Location。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => '输入文件的OSS Bucket。', + 'type' => 'string', + 'example' => 'bucket-test-in-****', + ], + ], + ], + 'BarrageCensorResult' => [ + 'description' => '弹幕审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值： **antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。', + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'DescCensorResult' => [ + 'description' => '描述审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'review', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'terrorism', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值： **antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'VideoCensorConfig' => [ + 'description' => '视频审查配置。', + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'description' => '视频截图结果的保存地址。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '截图输出文件 （OSS Object）。'."\n" + ."\n" + .'> 示例中{Count}是占位符，图片Object依次为`output00001-****.jpg`,`output00002-****.jpg`等。', + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'Location' => [ + 'description' => '截图输出OSS Bucket所在数据中心（OSS Location）。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => '截图输出文件所在OSS Bucket。', + 'type' => 'string', + 'example' => 'test-bucket-****', + ], + ], + ], + 'VideoCensor' => [ + 'description' => '是否需要审核视频内容。默认值：**true**。可取值：'."\n" + ."\n" + .'- **true**：审核'."\n" + ."\n" + .'- **false**：不审核', + 'type' => 'string', + 'example' => 'true', + ], + 'BizType' => [ + 'description' => '定制业务类型。默认common。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + 'JobId' => [ + 'description' => '媒体审核作业ID。', + 'type' => 'string', + 'example' => 'f8f166eea7a44e9bb0a4aecf9543****', + ], + 'UserData' => [ + 'description' => '用户自定义数据。', + 'type' => 'string', + 'example' => 'example userdata ****', + ], + 'Code' => [ + 'description' => '作业失败时错误码。执行成功时此参数不返回。', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'VensorCensorResult' => [ + 'description' => '视频审查结果。', + 'type' => 'object', + 'properties' => [ + 'VideoTimelines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoTimeline' => [ + 'description' => '详细时间点的审核结果，按照时间从小到大排序。', + 'type' => 'array', + 'items' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '视频中的位置。'."\n" + .'格式：`hh:mm:ss[.SSS]`。', + 'type' => 'string', + 'example' => '00:02:59.999', + ], + 'Object' => [ + 'description' => '截图输出文件 （OSS Object）。'."\n" + ."\n" + .'> 示例中{Count}是占位符，图片Object依次为`output00001-****.jpg`,`output00002-****.jpg`等。', + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => '包含多种类型审核结果的标签、分值等。', + 'type' => 'array', + 'items' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + .'- 图片智能鉴黄（porn）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **sexy：性感**'."\n" + .' - **porn：色情**'."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **bloody：血腥**'."\n" + .' - **explosion：爆炸烟光**'."\n" + .' - **outfit：特殊装束**'."\n" + .' - **logo：特殊标识**'."\n" + .' - **weapon：武器**'."\n" + .' - **politics：涉政**'."\n" + .' - **violence ：打斗**'."\n" + .' - **crowd：聚众**'."\n" + .' - **parade：游行**'."\n" + .' - **carcrash：车祸现场**'."\n" + .' - **flag：旗帜**'."\n" + .' - **location：地标**'."\n" + .' - **others：其他**'."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **ad：其他广告**'."\n" + .' - **politics：文字含涉政内容**'."\n" + .' - **porn：文字含涉黄内容**'."\n" + .' - **abuse：文字含辱骂内容**'."\n" + .' - **terrorism：文字含暴恐内容**'."\n" + .' - **contraband：文字含违禁内容**'."\n" + .' - **spam：文字含其他垃圾内容**'."\n" + .' - **npx：牛皮癣广告**'."\n" + .' - **qrcode：含二维码**'."\n" + .' - **programCode：含小程序码**'."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **meaningless：图片中无内容（例如黑屏、白屏）**'."\n" + .' - **PIP：画中画**'."\n" + .' - **smoking：吸烟**'."\n" + .' - **drivelive：车内直播**'."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **TV：含受管控的logo**'."\n" + .' - **trademark：含商标**', + 'type' => 'string', + 'example' => 'flood', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄'."\n" + .'- **terrorism**：暴恐涉政'."\n" + .'- **ad**：图文违规'."\n" + .'- **live**：不良场景'."\n" + .'- **logo**：图片Logo', + 'type' => 'string', + 'example' => 'porn', + ], + 'Rate' => [ + 'description' => '分值。', + 'type' => 'string', + 'example' => '99.99', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => '下一页标识', + 'type' => 'string', + 'example' => 'ea04afcca7cd4e80b9ece8fbb251****', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => '审核结果集合，包含各种场景（黄、暴、恐、政）的概要信息。', + 'type' => 'array', + 'items' => [ + 'description' => '审核结果详情。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'review', + ], + 'Label' => [ + 'description' => '审核结果的标签。'."\n" + .'- 图片智能鉴黄（porn）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **sexy：性感**'."\n" + .' - **porn：色情**'."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **bloody：血腥**'."\n" + .' - **explosion：爆炸烟光**'."\n" + .' - **outfit：特殊装束**'."\n" + .' - **logo：特殊标识**'."\n" + .' - **weapon：武器**'."\n" + .' - **politics：涉政**'."\n" + .' - **violence ：打斗**'."\n" + .' - **crowd：聚众**'."\n" + .' - **parade：游行**'."\n" + .' - **carcrash：车祸现场**'."\n" + .' - **flag：旗帜**'."\n" + .' - **location：地标**'."\n" + .' - **others：其他**'."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **ad：其他广告**'."\n" + .' - **politics：文字含涉政内容**'."\n" + .' - **porn：文字含涉黄内容**'."\n" + .' - **abuse：文字含辱骂内容**'."\n" + .' - **terrorism：文字含暴恐内容**'."\n" + .' - **contraband：文字含违禁内容**'."\n" + .' - **spam：文字含其他垃圾内容**'."\n" + .' - **npx：牛皮癣广告**'."\n" + .' - **qrcode：含二维码**'."\n" + .' - **programCode：含小程序码**'."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **meaningless：图片中无内容（例如黑屏、白屏）**'."\n" + .' - **PIP：画中画**'."\n" + .' - **smoking：吸烟**'."\n" + .' - **drivelive：车内直播**'."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal：正常**'."\n" + .' - **TV：含受管控的logo**'."\n" + .' - **trademark：含商标**', + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄'."\n" + .'- **terrorism**：暴恐涉政'."\n" + .'- **ad**：图文违规'."\n" + .'- **live**：不良场景'."\n" + .'- **logo**：图片Logo', + 'type' => 'string', + 'example' => 'terrorism', + ], + 'Rate' => [ + 'description' => '分值。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'PipelineId' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B42299E6-F71F-465F-8FE9-4FC2E3D3C2CA\\",\\n \\"MediaCensorJobDetail\\": {\\n \\"CreationTime\\": \\"2018-09-13T16:32:24Z\\",\\n \\"FinishTime\\": \\"2018-09-13T16:38:24Z\\",\\n \\"Suggestion\\": \\"block\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-out-test-****\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"Normal\\",\\n \\"Scene\\": \\"Antispam\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"terrorism\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"test-bucket-****\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543****\\",\\n \\"UserData\\": \\"example userdata ****\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"flood\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"99.99\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251****\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"review\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"terrorism\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询媒体审核作业详情', + 'summary' => '调用QueryMediaCensorJobDetail查询媒体审核作业的详细信息。', + 'description' => '媒体审核结果中视频部分是按照时间点从小到大排序组成一个时间线，如果视频时间非常长，查询时按分页返回第1页信息，如果需要详细查询视频部分的全量结果，可单独调用本接口。', + ], + 'QueryMediaCensorJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体审核作业ID。可以从提交媒体审核作业的返回参数中获取，多个使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'fa9c34be3bcf42919ac4d1775239****,78dc866518b843259669df58ed30****', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'type' => 'string', + 'required' => false, + 'example' => '79aff3eee82242e092899db5****', + ], + ], + [ + 'name' => 'MaximumPageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大返回数。'."\n" + ."\n" + .'- 默认：**30**'."\n" + .'- 取值：**1~300**', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的作业状态。取值：'."\n" + ."\n" + .'- **All**：全部。'."\n" + ."\n" + .'- **Queuing**：排队中。'."\n" + ."\n" + .'- **Analysing**：分析中。'."\n" + ."\n" + .'- **Fail**：失败。'."\n" + ."\n" + .'- **Success**：成功。', + 'type' => 'string', + 'required' => false, + 'example' => 'All', + 'default' => 'All', + ], + ], + [ + 'name' => 'StartOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '最早任务创建时间。'."\n" + ."\n" + .'- 日期格式按照ISO8601标准表示，并需要使用UTC时间。'."\n" + .'- 格式为：YYYY-MM-DDThh:mm:ssZ 。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-22T03:48:05Z'."\n", + ], + ], + [ + 'name' => 'EndOfJobCreatedTimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '最晚任务创建时间。'."\n" + ."\n" + .'- 日期格式按照ISO8601标准表示，并需要使用UTC时间。'."\n" + .'- 格式为：YYYY-MM-DDThh:mm:ssZ 。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-14T02:16:07Z'."\n", + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'MediaCensorJobList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MediaCensorJob' => [ + 'description' => '媒体审核作业列表。', + 'type' => 'array', + 'items' => [ + 'description' => '媒体审核作业详细信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2021-11-04T07:25:48Z'."\n", + ], + 'FinishTime' => [ + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2021-11-04T07:25:50Z'."\n", + ], + 'Suggestion' => [ + 'description' => '处理建议。可取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'pass', + ], + 'CoverImageCensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CoverImageCensorResult' => [ + 'description' => '封面图片审查结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '封面图片审查结果详细信息。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '封面图片的OSS Object。', + 'type' => 'string', + 'example' => 'test/ai/censor/v2/vme-****.jpg'."\n", + ], + 'Location' => [ + 'description' => '封面图片的OSS Object。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Bucket' => [ + 'description' => '封面图片的OSS Bucket。', + 'type' => 'string', + 'example' => 'example-Bucket-****'."\n", + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => '作业审核结果。', + 'type' => 'array', + 'items' => [ + 'description' => '作业审核结果详细信息。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '作业整体审核结果。取值：'."\n" + ."\n" + .'- **pass**：通过。'."\n" + .'- **review**：人工重审。'."\n" + .'- **block**：拦截。'."\n" + ."\n" + .'> 任何一种类型的审核结果是review时，整体结果为review，任何一种类型的审核结果是block时，整体结果为block。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- 图片智能鉴黄（porn）审核结果分类：'."\n" + .' - **nomal**：正常。'."\n" + .' - **sexy**：性感。'."\n" + .' - **porn**：色情。'."\n" + ."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **naomal**：正常。'."\n" + .' - **bloody**：血腥。'."\n" + .' - **explosion**：爆炸烟光。'."\n" + .' - **outfit**：特殊装束。'."\n" + .' - **logo**：特殊标识。'."\n" + .' - **weapon**：武器。'."\n" + .' - **polotocs**：涉政。'."\n" + .' - **violence**：打斗。'."\n" + .' - **crowd**：聚众。'."\n" + .' - **parade**：游行。'."\n" + .' - **carcrash**：车祸现场。'."\n" + .' - **flag**：旗帜。'."\n" + .' - **location**：地标。'."\n" + .' - **others**：其他。'."\n" + ."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **ad**：其他广告。'."\n" + .' - **politics**：文字含涉政内容。'."\n" + .' - **porn**：文字含涉黄内容。'."\n" + .' - **abuse**：文字含辱骂内容。'."\n" + .' - **terrorism**：文字含暴恐内容。'."\n" + .' - **contraband**：文字含违禁内容。'."\n" + .' - **spam**：文字含其他垃圾内容。'."\n" + .' - **npx**：牛皮藓广告。'."\n" + .' - **qrcode**：含二维码。'."\n" + .' - **programCode**：含小程序码。'."\n" + ."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .' - **PIP**：画中画。'."\n" + .' - **smoking**：吸烟。'."\n" + .' - **drivelive**：车内直播。'."\n" + ."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **TV**：含受管控的Logo。'."\n" + .' - **trademark**：含商标。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄'."\n" + .'- **terrorism**：暴恐涉政'."\n" + .'- **ad**：图文违规'."\n" + .'- **live**：不良场景'."\n" + .'- **logo**：图片logo', + 'type' => 'string', + 'example' => 'live', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'description' => '作业状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TitleCensorResult' => [ + 'description' => '标题审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'Message' => [ + 'description' => '作业失败时错误信息。执行成功时不返回此参数。', + 'type' => 'string', + 'example' => 'The resource operated cannot be found', + ], + 'Input' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '输入文件的OSS Object。', + 'type' => 'string', + 'example' => 'test/ai/censor/test-****.mp4', + ], + 'Location' => [ + 'description' => '输入文件的OSS Location。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai'."\n", + ], + 'Bucket' => [ + 'description' => '输入文件的OSS Bucket。', + 'type' => 'string', + 'example' => 'bucket-test-in-****', + ], + ], + ], + 'BarrageCensorResult' => [ + 'description' => '弹幕审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '99.91', + ], + ], + ], + 'DescCensorResult' => [ + 'description' => '描述审核结果。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- **normal**：普通'."\n" + .'- **spam**：含垃圾信息'."\n" + .'- **ad**：广告'."\n" + .'- **abuse**：辱骂'."\n" + .'- **flood**：灌水'."\n" + .'- **contraband**：违禁'."\n" + .'- **meaningless**：无意义', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。取固定值：**antispam**，文本反垃圾。', + 'type' => 'string', + 'example' => 'antispam', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'VideoCensorConfig' => [ + 'description' => '视频审查配置。', + 'type' => 'object', + 'properties' => [ + 'OutputFile' => [ + 'description' => '视频截图结果的保存地址。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '截图输出文件 （OSS Object）。'."\n" + ."\n" + .'> 示例中{Count}是占位符，图片Object依次为`output00001-****.jpg,output00002-****.jpg`等。', + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'Location' => [ + 'description' => '截图输出OSS Bucket所在的OSS Location。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai'."\n", + ], + 'Bucket' => [ + 'description' => '截图输出文件所在OSS Bucket。', + 'type' => 'string', + 'example' => 'test-bucket-****'."\n", + ], + ], + ], + 'VideoCensor' => [ + 'description' => '是否需要审核视频内容。默认值：**true**。可取值：'."\n" + ."\n" + .'- **true**：审核'."\n" + ."\n" + .'- **false**：不审核', + 'type' => 'string', + 'example' => 'true', + ], + 'BizType' => [ + 'description' => '审核模板。默认common（默认模板）。'."\n" + ."\n" + .'> 不填默认为common，如果是通过提交工单自定义的审核模板，此项返回UID。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + 'JobId' => [ + 'description' => '媒体审核作业ID。', + 'type' => 'string', + 'example' => 'f8f166eea7a44e9bb0a4aecf9543', + ], + 'UserData' => [ + 'description' => '用户自定义数据。', + 'type' => 'string', + 'example' => 'example userdata ****'."\n", + ], + 'Code' => [ + 'description' => '作业失败时错误码。执行成功时此参数不返回。', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceNotFound', + ], + 'VensorCensorResult' => [ + 'description' => '视频审查结果。', + 'type' => 'object', + 'properties' => [ + 'VideoTimelines' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VideoTimeline' => [ + 'description' => '详细时间点的审核结果，按照时间从小到大排序。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '视频中的位置。格式：`hh:mm:ss[.SSS]`。', + 'type' => 'string', + 'example' => '00:02:59.999', + ], + 'Object' => [ + 'description' => '截图输出文件 （OSS Object）。'."\n" + ."\n" + .'> 示例中{Count}是占位符，图片Object依次为`output00001-****.jpg`，`output00002-****.jpg`等。', + 'type' => 'string', + 'example' => 'output{Count}.jpg', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => '包含多种类型审核结果的标签、分值等。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过'."\n" + .'- **review**：人工重审'."\n" + .'- **block**：拦截', + 'type' => 'string', + 'example' => 'block', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- 图片智能鉴黄（porn）审核结果分类：'."\n" + .' - **nomal**：正常。'."\n" + .' - **sexy**：性感。'."\n" + .' - **porn**：色情。'."\n" + ."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **naomal**：正常。'."\n" + .' - **bloody**：血腥。'."\n" + .' - **explosion**：爆炸烟光。'."\n" + .' - **outfit**：特殊装束。'."\n" + .' - **logo**：特殊标识。'."\n" + .' - **weapon**：武器。'."\n" + .' - **polotocs**：涉政。'."\n" + .' - **violence**：打斗。'."\n" + .' - **crowd**：聚众。'."\n" + .' - **parade**：游行。'."\n" + .' - **carcrash**：车祸现场。'."\n" + .' - **flag**：旗帜。'."\n" + .' - **location**：地标。'."\n" + .' - **others**：其他。'."\n" + ."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **ad**：其他广告。'."\n" + .' - **politics**：文字含涉政内容。'."\n" + .' - **porn**：文字含涉黄内容。'."\n" + .' - **abuse**：文字含辱骂内容。'."\n" + .' - **terrorism**：文字含暴恐内容。'."\n" + .' - **contraband**：文字含违禁内容。'."\n" + .' - **spam**：文字含其他垃圾内容。'."\n" + .' - **npx**：牛皮藓广告。'."\n" + .' - **qrcode**：含二维码。'."\n" + .' - **programCode**：含小程序码。'."\n" + ."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .' - **PIP**：画中画。'."\n" + .' - **smoking**：吸烟。'."\n" + .' - **drivelive**：车内直播。'."\n" + ."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **TV**：含受管控的Logo。'."\n" + .' - **trademark**：含商标。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片logo。', + 'type' => 'string', + 'example' => 'porn', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => '下一页标识。', + 'type' => 'string', + 'example' => 'ea04afcca7cd4e80b9ece8fbb251', + ], + 'CensorResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CensorResult' => [ + 'description' => '审核结果集合，包含各种场景（黄、暴、恐、政）的概要信息。', + 'type' => 'array', + 'items' => [ + 'description' => '审核结果详细信息。', + 'type' => 'object', + 'properties' => [ + 'Suggestion' => [ + 'description' => '处理建议。取值：'."\n" + ."\n" + .'- **pass**：通过。'."\n" + ."\n" + .'- **review**：人工重审。'."\n" + ."\n" + .'- **block**：拦截。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Label' => [ + 'description' => '审核结果的标签，多个使用半角逗号（,）分隔。'."\n" + ."\n" + .'- 图片智能鉴黄（porn）审核结果分类：'."\n" + .' - **nomal**：正常。'."\n" + .' - **sexy**：性感。'."\n" + .' - **porn**：色情。'."\n" + ."\n" + .'- 图片暴恐涉政（terrorism）结果分类：'."\n" + .' - **naomal**：正常。'."\n" + .' - **bloody**：血腥。'."\n" + .' - **explosion**：爆炸烟光。'."\n" + .' - **outfit**：特殊装束。'."\n" + .' - **logo**：特殊标识。'."\n" + .' - **weapon**：武器。'."\n" + .' - **polotocs**：涉政。'."\n" + .' - **violence**：打斗。'."\n" + .' - **crowd**：聚众。'."\n" + .' - **parade**：游行。'."\n" + .' - **carcrash**：车祸现场。'."\n" + .' - **flag**：旗帜。'."\n" + .' - **location**：地标。'."\n" + .' - **others**：其他。'."\n" + ."\n" + .'- 图文违规（ad）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **ad**：其他广告。'."\n" + .' - **politics**：文字含涉政内容。'."\n" + .' - **porn**：文字含涉黄内容。'."\n" + .' - **abuse**：文字含辱骂内容。'."\n" + .' - **terrorism**：文字含暴恐内容。'."\n" + .' - **contraband**：文字含违禁内容。'."\n" + .' - **spam**：文字含其他垃圾内容。'."\n" + .' - **npx**：牛皮藓广告。'."\n" + .' - **qrcode**：含二维码。'."\n" + .' - **programCode**：含小程序码。'."\n" + ."\n" + .'- 图片不良场景（live）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **meaningless**：图片中无内容（例如黑屏、白屏）。'."\n" + .' - **PIP**：画中画。'."\n" + .' - **smoking**：吸烟。'."\n" + .' - **drivelive**：车内直播。'."\n" + ."\n" + .'- 图片logo（logo）结果分类：'."\n" + .' - **normal**：正常。'."\n" + .' - **TV**：含受管控的Logo。'."\n" + .' - **trademark**：含商标。', + 'type' => 'string', + 'example' => 'meaningless', + ], + 'Scene' => [ + 'description' => '审核场景。'."\n" + ."\n" + .'- **porn**：鉴黄。'."\n" + .'- **terrorism**：暴恐涉政。'."\n" + .'- **ad**：图文违规。'."\n" + .'- **live**：不良场景。'."\n" + .'- **logo**：图片Logo。', + 'type' => 'string', + 'example' => 'ad', + ], + 'Rate' => [ + 'description' => '分值。可取值：0~100。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'PipelineId' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'example' => 'c5b30b7c0d0e4a0abde1d5f9e751****'."\n", + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1D5C080-8E2F-5030-8AB4-13092F17631B'."\n", + ], + 'NextPageToken' => [ + 'description' => '下一页标识，32位UUID。查询结果大于一页时返回，每次查询值都会更新。', + 'type' => 'string', + 'example' => '9b1a42bc6e8d46e6a1383b7e7f01****'."\n", + ], + 'NonExistIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => '不存在的作业ID列表。如果为空则不返回此参数。', + 'type' => 'array', + 'items' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '78dc866518b843259669df58ed30****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MediaCensorJobList\\": {\\n \\"MediaCensorJob\\": [\\n {\\n \\"CreationTime\\": \\"2021-11-04T07:25:48Z\\\\n\\",\\n \\"FinishTime\\": \\"2021-11-04T07:25:50Z\\\\n\\",\\n \\"Suggestion\\": \\"pass\\",\\n \\"CoverImageCensorResults\\": {\\n \\"CoverImageCensorResult\\": [\\n {\\n \\"Object\\": \\"test/ai/censor/v2/vme-****.jpg\\\\n\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Bucket\\": \\"example-Bucket-****\\\\n\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"live\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"Success\\",\\n \\"TitleCensorResult\\": {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"Message\\": \\"The resource operated cannot be found\\",\\n \\"Input\\": {\\n \\"Object\\": \\"test/ai/censor/test-****.mp4\\",\\n \\"Location\\": \\"oss-cn-shanghai\\\\n\\",\\n \\"Bucket\\": \\"bucket-test-in-****\\"\\n },\\n \\"BarrageCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"99.91\\"\\n },\\n \\"DescCensorResult\\": {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"antispam\\",\\n \\"Rate\\": \\"100\\"\\n },\\n \\"VideoCensorConfig\\": {\\n \\"OutputFile\\": {\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"Location\\": \\"oss-cn-shanghai\\\\n\\",\\n \\"Bucket\\": \\"test-bucket-****\\\\n\\"\\n },\\n \\"VideoCensor\\": \\"true\\",\\n \\"BizType\\": \\"common\\"\\n },\\n \\"JobId\\": \\"f8f166eea7a44e9bb0a4aecf9543\\",\\n \\"UserData\\": \\"example userdata ****\\\\n\\",\\n \\"Code\\": \\"InvalidParameter.ResourceNotFound\\",\\n \\"VensorCensorResult\\": {\\n \\"VideoTimelines\\": {\\n \\"VideoTimeline\\": [\\n {\\n \\"Timestamp\\": \\"00:02:59.999\\",\\n \\"Object\\": \\"output{Count}.jpg\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"block\\",\\n \\"Label\\": \\"normal\\",\\n \\"Scene\\": \\"porn\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"NextPageToken\\": \\"ea04afcca7cd4e80b9ece8fbb251\\",\\n \\"CensorResults\\": {\\n \\"CensorResult\\": [\\n {\\n \\"Suggestion\\": \\"pass\\",\\n \\"Label\\": \\"meaningless\\",\\n \\"Scene\\": \\"ad\\",\\n \\"Rate\\": \\"100\\"\\n }\\n ]\\n }\\n },\\n \\"PipelineId\\": \\"c5b30b7c0d0e4a0abde1d5f9e751****\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D1D5C080-8E2F-5030-8AB4-13092F17631B\\\\n\\",\\n \\"NextPageToken\\": \\"9b1a42bc6e8d46e6a1383b7e7f01****\\\\n\\",\\n \\"NonExistIds\\": {\\n \\"String\\": [\\n \\"78dc866518b843259669df58ed30****\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询媒体审核作业列表', + 'summary' => '调用QueryMediaCensorJobList查询媒体审核作业列表。', + 'description' => '本接口只支持查询三个月内的媒体审核作业列表。', + ], + 'CreateCustomTemplate' => [ + 'summary' => '本接口允许用户创建自定义的媒体处理模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-template', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型。', + 'description' => '模板类型。'."\n" + .'- 1：转码模板'."\n" + .'- 2：截图模板'."\n" + .'- 3：动图模板'."\n" + .'- 4：图片水印模板'."\n" + .'- 5：文字水印模板'."\n" + .'- 6：字幕模板'."\n" + .'- 7：AI智能审核'."\n" + .'- 8：AI智能封面'."\n" + .'- 9：AI智能擦除'."\n" + .'- 10：AI智能DNA模板'."\n" + .'- 11：AI智能标签模板', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Subtype', + 'in' => 'query', + 'schema' => [ + 'title' => '模板子类型。', + 'description' => '模板子类型。'."\n" + ."\n" + .'转码模板子类型：'."\n" + .'- 1：普通转码模板（Normal）'."\n" + .'- 2：音频转码模板（AudioTranscode）'."\n" + .'- 3：转封装（Remux）'."\n" + .'- 4：窄带高清1.0（NarrowBandV1）'."\n" + .'- 5：窄带高清2.0（NarrowBandV2）'."\n" + ."\n" + .'截图模板子类型：'."\n" + .'- 1：普通截图/静态截图（Normal）'."\n" + .'- 2：雪碧图（Sprite）'."\n" + .'- 3：WebVtt截图（WebVtt）'."\n" + ."\n" + .'AI审核模板子类型：'."\n" + .'- 1：视频审核（Video） '."\n" + .'- 2：音频审核（Audio）'."\n" + .'- 3：图片审核（Image）'."\n" + ."\n" + .'AI智能擦除模板子类型：'."\n" + .'- 1：图标擦除（VideoDelogo）'."\n" + .'- 2：字幕擦除（VideoDetext）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '模板参数', + 'description' => '模板配置。详细参数说明请参见[模板参数](~~448291~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'CustomTemplate' => [ + 'title' => '模板信息', + 'description' => '模板信息。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'test-template', + ], + 'Type' => [ + 'title' => '模板类型ID', + 'description' => '模板类型ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TypeName' => [ + 'title' => '模板类型名称', + 'description' => '模板类型名称。', + 'type' => 'string', + 'example' => 'TranscodeTemplate', + ], + 'Subtype' => [ + 'title' => '模板子类型名称', + 'description' => '模板子类型名称。', + 'type' => 'string', + 'example' => 'Remux', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsDefault' => [ + 'title' => '是否默认模板', + 'description' => '是否默认模板。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TemplateConfig' => [ + 'title' => '模板参数', + 'description' => '模板配置。', + 'type' => 'string', + 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间。', + 'type' => 'string', + 'example' => '2022-04-19T02:04:31Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间。', + 'type' => 'string', + 'example' => '2022-04-19T02:04:31Z', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CustomTemplate\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": \\"Remux\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"flv\\\\\\"},\\\\\\"Video\\\\\\":{},\\\\\\"Audio\\\\\\":{}}\\",\\n \\"CreateTime\\": \\"2022-04-19T02:04:31Z\\",\\n \\"ModifiedTime\\": \\"2022-04-19T02:04:31Z\\"\\n }\\n}","type":"json"}]', + 'title' => '创建用户自定义模板', + ], + 'GetSystemTemplate' => [ + 'summary' => '获取单个系统预置模板信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'S00000001-100060', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SystemTemplate' => [ + 'title' => '模板信息', + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'S00000001-100060', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'M3U8-2K', + ], + 'Type' => [ + 'title' => '模板类型ID', + 'description' => '模板类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TypeName' => [ + 'title' => '模板类型名称', + 'description' => '模板类型名称', + 'type' => 'string', + 'example' => 'TranscodeTemplate', + ], + 'Subtype' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubtypeName' => [ + 'title' => '模板子类型名称', + 'description' => '模板子类型名称', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TemplateConfig' => [ + 'title' => '模板参数', + 'description' => '模板参数', + 'type' => 'string', + 'example' => '{"Container":{"Format":"m3u8"},"TransConfig":{"TransMode":"onepass"},"Video":{"Codec":"H.264","Maxrate":8000,"Preset":"medium","PixFmt":"yuv420p","Width":2048,"Bitrate":3500},"Audio":{"Codec":"aac","Bitrate":160,"Samplerate":44100,"Channels":2}}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SystemTemplate\\": {\\n \\"TemplateId\\": \\"S00000001-100060\\",\\n \\"TemplateName\\": \\"M3U8-2K\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Normal\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"m3u8\\\\\\"},\\\\\\"TransConfig\\\\\\":{\\\\\\"TransMode\\\\\\":\\\\\\"onepass\\\\\\"},\\\\\\"Video\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"H.264\\\\\\",\\\\\\"Maxrate\\\\\\":8000,\\\\\\"Preset\\\\\\":\\\\\\"medium\\\\\\",\\\\\\"PixFmt\\\\\\":\\\\\\"yuv420p\\\\\\",\\\\\\"Width\\\\\\":2048,\\\\\\"Bitrate\\\\\\":3500},\\\\\\"Audio\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"aac\\\\\\",\\\\\\"Bitrate\\\\\\":160,\\\\\\"Samplerate\\\\\\":44100,\\\\\\"Channels\\\\\\":2}}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取系统模板信息', + ], + 'GetCustomTemplate' => [ + 'summary' => '获取媒体处理用户自定义模板信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceEO4QPO', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '获取默认模板时的模板类型ID。TemplateId为空时该参数必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Subtype', + 'in' => 'query', + 'schema' => [ + 'description' => '模板子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'CustomTemplate' => [ + 'title' => '模板信息', + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => '测试截图模板', + ], + 'Type' => [ + 'title' => '模板类型ID', + 'description' => '模板类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TypeName' => [ + 'title' => '模板类型名称', + 'description' => '模板类型名称', + 'type' => 'string', + 'example' => 'SnapshotTemplate', + ], + 'Subtype' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubtypeName' => [ + 'title' => '模板子类型名称', + 'description' => '模板子类型名称', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'IsDefault' => [ + 'title' => '是否默认模板', + 'description' => '是否默认模板', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TemplateConfig' => [ + 'title' => '模板参数', + 'description' => '模板参数', + 'type' => 'string', + 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间', + 'type' => 'string', + 'example' => '2022-01-01T10:00:00Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间', + 'type' => 'string', + 'example' => '2022-01-01T11:00:00Z'."\n", + ], + 'FrontendHint' => [ + 'type' => 'object', + 'properties' => [ + 'TranscodeTemplateHint' => [ + 'type' => 'object', + 'properties' => [ + 'BitrateControlType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CustomTemplate\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"测试截图模板\\",\\n \\"Type\\": 2,\\n \\"TypeName\\": \\"SnapshotTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Normal\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Type\\\\\\":\\\\\\"Normal\\\\\\",\\\\\\"FrameType\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"Time\\\\\\":0,\\\\\\"Count\\\\\\":10}\\",\\n \\"CreateTime\\": \\"2022-01-01T10:00:00Z\\",\\n \\"ModifiedTime\\": \\"2022-01-01T11:00:00Z\\\\n\\",\\n \\"FrontendHint\\": {\\n \\"TranscodeTemplateHint\\": {\\n \\"BitrateControlType\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取自定义模板信息', + 'description' => '该接口可以根据TemplateId获取指定ID的模板信息；也可以获取默认模板信息。'."\n" + .'当TemplateId非空时，忽略其他参数并获取指定TemplateId的模板信息；当TemplateId为空时会根据其他参数获取用户默认模板。此时Type必填。'."\n" + ."\n" + .'模板类型（Type）：'."\n" + .'1. 1：转码模板'."\n" + .'2. 2：截图模板'."\n" + .'3. 3：动图模板'."\n" + .'4. 4：图片水印模板'."\n" + .'5. 5：文字水印模板'."\n" + .'6. 6：字幕模板'."\n" + .'7. 7：AI智能审核'."\n" + .'8. 8：AI智能封面'."\n" + .'9. 9：AI智能擦除'."\n" + ."\n" + .'转码模板子类型（Subtype）：'."\n" + .'1. 1：普通转码模板（Normal）'."\n" + .'2. 2：音频转码模板（AudioTranscode）'."\n" + .'3. 3：转封装（Remux）'."\n" + .'4. 4：窄带高清1.0（NarrowBandV1）'."\n" + .'5. 5：窄带高清2.0（NarrowBandV2）'."\n" + ."\n" + .'截图模板子类型（Subtype）：'."\n" + .'1. 1：普通截图/静态截图（Normal）'."\n" + .'2. 2：雪碧图（Sprite）'."\n" + .'3. 3：WebVtt截图（WebVtt）'."\n" + ."\n" + .'AI审核模板子类型（Subtype）：'."\n" + .'1. 1：视频审核（Video） '."\n" + .'2. 2：音频审核（Audio）'."\n" + .'3. 3：图片审核（Image）'."\n" + ."\n" + .'AI智能擦除模板子类型（Subtype）：'."\n" + .'1. 1：图标擦除（VideoDelogo）'."\n" + .'2. 2：字幕擦除（VideoDetext）', + ], + 'SetDefaultCustomTemplate' => [ + 'summary' => '本接口用于设置用户自定义的点播媒体处理默认模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '设置默认自定义模板', + ], + 'UpdateCustomTemplate' => [ + 'summary' => '修改媒体处理用户自定义模板信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test-template', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '模板参数', + 'description' => '[模板参数](~~448291~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{"param": "sample"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改用户自定义模板信息', + ], + 'DeleteCustomTemplate' => [ + 'summary' => '删除用户自定义模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '用户自定义模板ID', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除自定义模板', + ], + 'ListSystemTemplates' => [ + 'summary' => '获取媒体处理系统预置模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceHPAMBQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型。逗号分隔', + 'description' => '模板类型。逗号分隔', + 'type' => 'string', + 'required' => true, + 'example' => '1,2', + ], + ], + [ + 'name' => 'Subtype', + 'in' => 'query', + 'schema' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'required' => false, + 'example' => 'SampleTemplate', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '模板状态：Normal正常，Invisible不可见，ALL全部', + 'description' => '模板状态：'."\n" + ."\n" + .'- Normal正常'."\n" + ."\n" + .'- Invisible不可见'."\n" + ."\n" + .'- ALL全部', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数目', + 'description' => '分页数目', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小。默认值20。最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Total' => [ + 'title' => '模板总数', + 'description' => '模板总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SystemTemplateList' => [ + 'title' => '模板信息列表', + 'description' => '模板信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '系统预置模板', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板Id', + 'type' => 'string', + 'example' => 'S00000001-000000', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'FLV-COPY', + ], + 'Type' => [ + 'title' => '模板类型ID', + 'description' => '模板类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TypeName' => [ + 'title' => '模板类型名称', + 'description' => '模板类型名称', + 'type' => 'string', + 'example' => 'TranscodeTemplate', + ], + 'Subtype' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubtypeName' => [ + 'title' => '模板子类型名称', + 'description' => '模板子类型名称', + 'type' => 'string', + 'example' => 'Remux', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TemplateConfig' => [ + 'title' => '模板参数', + 'description' => '模板参数', + 'type' => 'string', + 'example' => '{"Container":{"Format":"flv"},"Video":{},"Audio":{}}', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 20,\\n \\"SystemTemplateList\\": [\\n {\\n \\"TemplateId\\": \\"S00000001-000000\\",\\n \\"TemplateName\\": \\"FLV-COPY\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 1,\\n \\"SubtypeName\\": \\"Remux\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"flv\\\\\\"},\\\\\\"Video\\\\\\":{},\\\\\\"Audio\\\\\\":{}}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取系统模板列表', + 'description' => '模板类型（Type）：'."\n" + .'1. 1：转码模板'."\n" + .'2. 2：截图模板'."\n" + .'3. 3：动图模板'."\n" + .'4. 4：图片水印模板'."\n" + .'5. 5：文字水印模板'."\n" + .'6. 6：字幕模板'."\n" + .'7. 7：AI智能审核'."\n" + .'8. 8：AI智能封面'."\n" + .'9. 9：AI智能擦除'."\n" + ."\n" + .'转码模板子类型（Subtype）：'."\n" + .'1. 1：普通转码模板（Normal）'."\n" + .'2. 2：音频转码模板（AudioTranscode）'."\n" + .'3. 3：转封装（Remux）'."\n" + .'4. 4：窄带高清1.0（NarrowBandV1）'."\n" + .'5. 5：窄带高清2.0（NarrowBandV2）'."\n" + ."\n" + .'截图模板子类型（Subtype）：'."\n" + .'1. 1：普通截图/静态截图（Normal）'."\n" + .'2. 2：雪碧图（Sprite）'."\n" + .'3. 3：WebVtt截图（WebVtt）'."\n" + ."\n" + .'AI审核模板子类型（Subtype）：'."\n" + .'1. 1：视频审核（Video） '."\n" + .'2. 2：音频审核（Audio）'."\n" + .'3. 3：图片审核（Image）'."\n" + ."\n" + .'AI智能擦除模板子类型（Subtype）：'."\n" + .'1. 1：图标擦除（VideoDelogo）'."\n" + .'2. 2：字幕擦除（VideoDetext）', + ], + 'ListCustomTemplates' => [ + 'summary' => '获取用户自定义点播媒体处理模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceEO4QPO', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型。逗号分隔', + 'description' => '模板类型。'."\n" + .'- 1：转码模板'."\n" + .'- 2：截图模板'."\n" + .'- 3：动图模板'."\n" + .'- 4：图片水印模板'."\n" + .'- 5：文字水印模板'."\n" + .'- 6：字幕模板'."\n" + .'- 7：AI 智能审核'."\n" + .'- 8：AI 智能封面'."\n" + .'- 9：AI 智能擦除', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Subtype', + 'in' => 'query', + 'schema' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID。'."\n" + .'- 转码模板子类型：'."\n" + .' - 1：普通转码模板（Normal）'."\n" + .' - 2：音频转码模板（AudioTranscode）'."\n" + .' - 3：转封装（Remux）'."\n" + .' - 4：窄带高清 1.0（NarrowBandV1）'."\n" + .' - 5：窄带高清 2.0（NarrowBandV2）'."\n" + .'- 截图模板子类型（Subtype）：'."\n" + .' - 1：普通截图/静态截图（Normal）'."\n" + .' - 2：雪碧图（Sprite）'."\n" + .' - 3：WebVtt 截图（WebVtt）'."\n" + .'- AI 审核模板子类型（Subtype）：'."\n" + .' - 1：视频审核（Video）'."\n" + .' - 2：音频审核（Audio）'."\n" + .' - 3：图片审核（Image）'."\n" + .'- AI 智能擦除模板子类型（Subtype）：'."\n" + .' - 1：图标擦除（VideoDelogo）'."\n" + .' - 2：字幕擦除（VideoDetext）', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-template', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数目', + 'description' => '分页数目。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', + 'description' => '排序顺序。取值：'."\n" + .'- CreateTimeDesc（按照创建时间逆序排列）'."\n" + .'- CreateTimeAsc（按照创建时间顺序排列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CreateTimeDesc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Total' => [ + 'title' => '模板总数', + 'description' => '模板总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CustomTemplateList' => [ + 'title' => '模板信息列表', + 'description' => '模板信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义模板信息。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'test-template', + ], + 'Type' => [ + 'title' => '模板类型ID', + 'description' => '模板类型ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TypeName' => [ + 'title' => '模板类型名称', + 'description' => '模板类型名称。', + 'type' => 'string', + 'example' => 'TranscodeTemplate', + ], + 'Subtype' => [ + 'title' => '模板子类型ID', + 'description' => '模板子类型ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SubtypeName' => [ + 'title' => '模板子类型名称', + 'description' => '模板子类型名称。', + 'type' => 'string', + 'example' => 'AudioTranscode', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Normal' => 'Normal', + ], + 'example' => 'Normal', + ], + 'IsDefault' => [ + 'title' => '是否默认模板', + 'description' => '是否默认模板。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'TemplateConfig' => [ + 'title' => '模板参数', + 'description' => '模板参数。', + 'type' => 'string', + 'example' => '{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间。', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间。', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'FrontendHint' => [ + 'type' => 'object', + 'properties' => [ + 'TranscodeTemplateHint' => [ + 'type' => 'object', + 'properties' => [ + 'BitrateControlType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 20,\\n \\"CustomTemplateList\\": [\\n {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Type\\": 1,\\n \\"TypeName\\": \\"TranscodeTemplate\\",\\n \\"Subtype\\": 2,\\n \\"SubtypeName\\": \\"AudioTranscode\\",\\n \\"Status\\": \\"Normal\\",\\n \\"IsDefault\\": true,\\n \\"TemplateConfig\\": \\"{\\\\\\"Container\\\\\\":{\\\\\\"Format\\\\\\":\\\\\\"mp3\\\\\\"},\\\\\\"Audio\\\\\\":{\\\\\\"Codec\\\\\\":\\\\\\"mp3\\\\\\",\\\\\\"Bitrate\\\\\\":\\\\\\"64\\\\\\",\\\\\\"Samplerate\\\\\\":\\\\\\"22050\\\\\\",\\\\\\"Channels\\\\\\":\\\\\\"2\\\\\\"}}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FrontendHint\\": {\\n \\"TranscodeTemplateHint\\": {\\n \\"BitrateControlType\\": \\"\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取自定义模板列表', + ], + 'CreatePipeline' => [ + 'summary' => '本接口用于创建媒体处理管道，实现媒体文件的自动化和批量处理。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '管道名称', + 'description' => '管道名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-pipeline', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'title' => '管道类型。', + 'description' => '管道类型。取值：'."\n" + ."\n" + .'- Standard：标准管道'."\n" + ."\n" + .'- Boost：倍速转码管道'."\n" + ."\n" + .'- NarrowBandHDV2：窄带高清2.0管道', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Boost' => '倍速转码管道', + 'Standard' => '标准管道', + 'NarrowBandHDV2' => '窄带高清2.0管道', + ], + 'example' => 'Standard', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'title' => '优先级，1-10，默认6。数值越大，优先级越高', + 'description' => '优先级，1-10，默认6。数值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Pipeline' => [ + 'title' => '管道信息', + 'description' => '管道信息', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道Id', + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'title' => '管道名称', + 'description' => '管道名称', + 'type' => 'string', + 'example' => 'test-pipeline', + ], + 'Speed' => [ + 'title' => '管道类型', + 'description' => '管道类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Boost' => '倍速转码管道', + 'Standard' => '标准管道', + 'NarrowBandHDV2' => '窄带高清2.0管道', + ], + 'example' => 'Standard', + ], + 'Priority' => [ + 'title' => '管道优先级', + 'description' => '管道优先级', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Status' => [ + 'title' => '管道状态', + 'description' => '管道状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Active' => '正常', + 'Paused' => '停用', + ], + 'example' => 'Active', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Pipeline\\": {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n}","type":"json"}]', + 'title' => '创建管道', + ], + 'GetPipeline' => [ + 'summary' => '获取用户管道详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'title' => '管道ID', + 'description' => '管道ID', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Pipeline' => [ + 'title' => '管道信息', + 'description' => '管道信息', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道Id', + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'title' => '管道名称', + 'description' => '管道名称', + 'type' => 'string', + 'example' => 'test-pipeline', + ], + 'Speed' => [ + 'title' => '管道类型', + 'description' => '管道类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Speed' => '标准管道', + 'Boost' => '倍速转码管道', + 'NarrowBandHDV2' => '窄带高清2.0管道', + ], + 'example' => 'Standard', + ], + 'Priority' => [ + 'title' => '管道优先级', + 'description' => '管道优先级。取值范围为1-10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Status' => [ + 'title' => '管道状态', + 'description' => '管道状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Active' => '正常', + 'Paused' => '停用', + ], + 'example' => 'Active', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Pipeline\\": {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n}","type":"json"}]', + 'title' => '获取管道详细信息', + ], + 'UpdatePipeline' => [ + 'summary' => '更新用户管道信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'title' => '管道ID', + 'description' => '管道ID', + 'type' => 'string', + 'required' => true, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '管道名称', + 'description' => '管道名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test-pipeline', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '管道状态。', + 'description' => '管道状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Active' => '正常', + 'Paused' => '停用', + ], + 'example' => 'Paused', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'title' => '优先级', + 'description' => '优先级。取值范围：1-10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新管道信息', + ], + 'DeletePipeline' => [ + 'summary' => '删除用户管道信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'title' => '管道ID', + 'description' => '管道ID', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否成功', + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除用户管道', + ], + 'ListPipelines' => [ + 'summary' => '获取用户管道列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'title' => '管道类型。', + 'description' => '管道类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Boost' => '倍速转码管道', + 'Standard' => '标准管道', + 'NarrowBandHDV2' => '窄带高清2.0管道', + ], + 'example' => 'Standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PipelineList' => [ + 'description' => '管道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管道详细信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道Id', + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'title' => '管道名称', + 'description' => '管道名称', + 'type' => 'string', + 'example' => 'test-pipeline', + ], + 'Speed' => [ + 'title' => '管道类型', + 'description' => '管道类型', + 'type' => 'string', + 'example' => 'Standard', + ], + 'Priority' => [ + 'title' => '管道优先级', + 'description' => '管道优先级', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Status' => [ + 'title' => '管道状态', + 'description' => '管道状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Active' => '正常', + 'Paused' => '停用', + ], + 'example' => 'Active', + ], + 'CreateTime' => [ + 'title' => '模板创建时间', + 'description' => '模板创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'title' => '模板修改时间', + 'description' => '模板修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PipelineList\\": [\\n {\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"test-pipeline\\",\\n \\"Speed\\": \\"Standard\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Active\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:17:54Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取管道列表', + ], + 'SubmitTranscodeJob' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '任务名字。', + 'description' => '任务名字。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'InputGroup', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务输入组 (目前只支持一个)。', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。'."\n" + .'> URL中的 OSS bucket 需要先添加到IMS [存储管理](~~609918~~)后再使用。'."\n" + ."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'InputUrl' => [ + 'title' => '输入流路径： 仅当 type 为 Media 是才生效，让用户可以选择该媒资下的特定文件作为输入。 - 系统会检查该媒资下是否存在这个 inputUrl。', + 'description' => '输入流路径：'."\n" + .'- 仅当 type 为 Media 是才生效，让用户可以选择该媒资下的特定文件作为输入。 '."\n" + .' - 系统会检查该媒资下是否存在这个 inputUrl。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => true, + ], + 'required' => true, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'OutputGroup', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务输出组。', + 'description' => '任务输出组。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。'."\n" + .'> URL中的 OSS bucket 需要先添加到IMS [存储管理](~~609918~~)后再使用。'."\n" + ."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'OutputUrl' => [ + 'title' => '输入流路径： 仅当 Type 为 Media时才生效，让用户可以选择该媒资下特定文件作为输出。 支持的占位符： - {MediaId}：媒资ID。 - {JobId}：转码子任务ID。 - {ExtName}：文件后缀，取转码模板的输出格式。 - {DestMd5}：转码输出文件的MD5值。 说明： 1、该参数必须包含{MediaId} 和 {JobId} 两个占位符。 2、输出的Bucket与MediaId所在Bucket相同。', + 'description' => '输出流路径： '."\n" + .' 仅当 Type 为 Media时才生效，让用户可以选择该媒资下特定文件作为输出。 '."\n" + .' 支持的占位符：'."\n" + .'- {MediaId}：媒资ID。'."\n" + .'- {JobId}：转码子任务ID。'."\n" + .'- {MediaBucket}：媒资ID所在的Bucket。'."\n" + .'- {ExtName}：文件后缀，取转码模板的输出格式。'."\n" + .'- {DestMd5}：转码输出文件的MD5值。 '."\n" + .'> 1. 该参数必须包含{MediaId} 和 {JobId} 两个占位符。'."\n" + .'> 2. 输出的Bucket与MediaId所在Bucket相同。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4', + ], + ], + 'required' => true, + ], + 'ProcessConfig' => [ + 'title' => '任务处理配置', + 'description' => '任务处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .'- high：针对高分辨率设备。'."\n" + .' '."\n" + .'默认值：high。', + 'type' => 'string', + 'required' => false, + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率，取值范围：[10,50000]，单位：Kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子，取值范围：[0,51]。默认值：编码格式为H264，默认值为23；编码格式为H265，默认值为26。'."\n" + .'> 如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'required' => false, + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽，取值范围：[128,4096]，单位：px，默认值：视频原始宽度。', + 'type' => 'string', + 'required' => false, + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高，取值范围：[128,4096]，单位：px，默认值：视频原始高度。', + 'type' => 'string', + 'required' => false, + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率，取值范围：(0,60]，默认值：取输入文件帧率。'."\n" + .'> 当输入文件帧率超过60时取60。', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数，取值范围：[1,1080000]，默认值：250。', + 'type' => 'string', + 'required' => false, + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'required' => false, + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切支持2种方式。 '."\n" + .'- 自动检测黑边并裁切，设置为“border”'."\n" + .'- 自定义裁切，参数格式：width:height:left:top，示例：1280:800:0:140', + 'type' => 'string', + 'required' => false, + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边参数，格式：width:height:left:top，示例：1280:800:0:140', + 'type' => 'string', + 'required' => false, + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小值，范围：[1000,128000]，默认值：6000，单位：Kb。', + 'type' => 'string', + 'required' => false, + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'required' => false, + 'example' => '6000', + ], + ], + 'required' => false, + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率，默认值：44100，支持22050、32000、44100、48000、96000，单位：Hz。', + 'type' => 'string', + 'required' => false, + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率，值范围：[8,1000]，单位：Kbps，默认值：128。', + 'type' => 'string', + 'required' => false, + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'required' => false, + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'required' => false, + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'required' => false, + 'example' => '8', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'mp4', + ], + ], + 'required' => false, + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'required' => false, + 'example' => '2,3', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'TransConfig' => [ + 'description' => '条件转码参数。', + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => '视频转码模式。取值如下：'."\n" + ."\n" + .'- onepass：一般用于ABR。编码速度较twopass更快。'."\n" + ."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + ."\n" + .'- CBR：固定码率模式。'."\n" + ."\n" + .'默认值：onepass。', + 'type' => 'string', + 'required' => false, + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'IsCheckVideoBitrate' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'IsCheckAudioBitrate' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：'."\n" + ."\n" + .'- 参数为空，并且codec和输入源不一样：false。'."\n" + ."\n" + .'- 参数为空，并且codec和输入源一样：true。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + ."\n" + .'可选值：rescale、crop、pad、none。'."\n" + ."\n" + .'默认值：none。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'Height' => [ + 'title' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'description' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'type' => 'string', + 'required' => false, + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '动态水印，显示时间设置。', + 'description' => '动态水印，显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'description' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'description' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'type' => 'string', + 'required' => false, + 'example' => 'ToEND', + ], + ], + 'required' => false, + ], + 'File' => [ + 'title' => '水印图片文件。', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'required' => false, + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体。默认：SimSun。', + 'description' => '字体。默认：SimSun。', + 'type' => 'string', + 'required' => false, + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色。', + 'description' => '颜色。', + 'type' => 'string', + 'required' => false, + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'description' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'description' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'Left' => [ + 'title' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'description' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'description' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'description' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'description' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'type' => 'string', + 'required' => false, + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式。', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式。', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件。', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。取值：'."\n" + .'- PrivateEncryption：阿里云私有加密。'."\n" + .'- HLSEncryption：HLS标准加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'required' => false, + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + 'KeyServiceType' => [ + 'title' => '密钥服务类型。目前仅支持KMS和Base64', + 'description' => '标准加密的密钥服务类型。取值：'."\n" + ."\n" + .'- KMS'."\n" + ."\n" + .'- Base64', + 'type' => 'string', + 'required' => false, + 'example' => 'KMS', + ], + ], + 'required' => false, + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'description' => '合流配置。', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '20.0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + 'required' => true, + ], + 'required' => true, + 'example' => 'user-data', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户数据。', + 'description' => '自定义设置，JSON格式，长度限制为512字节，支持[自定义回调地址配置](~~451631~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'user-data', + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务调度信息。', + 'description' => '任务调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '幂等性校验Key。', + 'description' => '幂等性校验Key。保证请求幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'TranscodeParentJob' => [ + 'title' => 'TranscodeParentJobWithSubJobDTO', + 'description' => 'TranscodeParentJobWithSubJobDTO', + 'type' => 'object', + 'properties' => [ + 'TranscodeJobList' => [ + 'title' => '子任务列表', + 'description' => '子任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子任务详情。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'Name' => [ + 'title' => '任务名', + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'transcode-job', + ], + 'ParentJobId' => [ + 'title' => '主任务 ID', + 'description' => '主任务 ID', + 'type' => 'string', + 'example' => '8b2198504dd340b7b3c9842a74fc9baa', + ], + 'JobId' => [ + 'title' => '子任务 ID', + 'description' => '子任务 ID', + 'type' => 'string', + 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', + ], + 'JobIndex' => [ + 'title' => '子任务在整个任务中的索引号', + 'description' => '子任务在整个任务中的索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InputGroup' => [ + 'title' => '任务输入组 (目前只支持单个输入)', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'InputUrl' => [ + 'description' => '输入流路径：'."\n" + ."\n" + .'- 仅当 type 为 Media 是才生效，让用户可以选择该媒资下的特定文件作为输入。'."\n" + .'- 系统会检查该媒资下是否存在这个 inputUrl。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4'."\n", + ], + ], + ], + ], + 'ProcessConfig' => [ + 'title' => '转码处理配置', + 'description' => '转码处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。'."\n" + .'支持baseline、main、high。'."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .'- high：针对高分辨率设备。'."\n" + ."\n" + .'默认值：high。', + 'type' => 'string', + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率。'."\n" + .' '."\n" + .'- 取值范围：[10，50000]。'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子。'."\n" + .' '."\n" + .'- 取值范围：[0，51]。'."\n" + .'- 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + ."\n" + .'如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始高度。', + 'type' => 'string', + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率。'."\n" + .' '."\n" + .'- 取值范围：(0,60]。'."\n" + .'- 当输入文件帧率超过60时取60。'."\n" + .'- 默认值：取输入文件帧率。', + 'type' => 'string', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数。'."\n" + .' '."\n" + .'- 取值范围：[1，1080000]。'."\n" + .'- 默认值：250。', + 'type' => 'string', + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切，支持2种方式。'."\n" + .' '."\n" + .'- 自动检测黑边并裁切，设置为“border”'."\n" + .'- 自定义裁切，参数格式：width:height:left:top。示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边 '."\n" + .'- 参数格式：width:height:left:top。'."\n" + .'- 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）', + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小'."\n" + .' '."\n" + .'- 值范围：[1000，128000]'."\n" + .'- 默认值：6000'."\n" + .'- 单位：Kb', + 'type' => 'string', + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值'."\n" + .'值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）'."\n" + .'值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'example' => '6000', + ], + ], + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率。'."\n" + .' '."\n" + .'- 默认值：44100'."\n" + .'- 支持22050、32000、44100、48000、96000，'."\n" + .'- 单位：Hz', + 'type' => 'string', + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率。'."\n" + .' '."\n" + .'- 值范围：[8，1000]'."\n" + .'- 单位：Kbps'."\n" + .'- 默认值：128', + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'example' => '2,3', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => '条件转码参数。', + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => '视频转码模式。取值：'."\n" + .'- onepass（默认值）：一般用于ABR。编码速度较twopass更快。'."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + .'- CBR：固定码率模式。', + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + .'- false（默认值）：不检查。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + .'- false（默认值）：不检查。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrate' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + .'- false（默认值）：不检查。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + .'- false（默认值）：不检查。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrate' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值规则：'."\n" + .'- 参数为空，并且codec和输入源不一样：false。'."\n" + .'- 参数为空，并且codec和输入源一样：true。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + .'- false（默认值）：不检查。', + 'type' => 'string', + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + ."\n" + .'可选值：rescale、crop、pad、none。'."\n" + ."\n" + .'默认值：none。', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'example' => '32', + ], + 'Height' => [ + 'title' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'description' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'type' => 'string', + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '动态水印，显示时间设置。', + 'description' => '动态水印，显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'description' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'type' => 'string', + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'description' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'File' => [ + 'title' => '水印图片文件。', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体。默认：SimSun。', + 'description' => '字体。默认：SimSun。', + 'type' => 'string', + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色。', + 'description' => '颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'description' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'type' => 'string', + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'description' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Left' => [ + 'title' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'description' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'type' => 'string', + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'description' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'description' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'description' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'type' => 'string', + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式。', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式。', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件。', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。', + 'type' => 'string', + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + 'KeyServiceType' => [ + 'title' => '密钥服务类型。目前仅支持KMS和Base64', + 'description' => '密钥服务类型。目前仅支持KMS和Base64', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'description' => '合流配置。', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.0', + ], + ], + ], + ], + ], + ], + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'OutputUrl' => [ + 'description' => '输出流路径： '."\n" + .' 仅当 Type 为 Media时才生效，让用户可以选择该媒资下特定文件作为输出。 '."\n" + .' 支持的占位符：'."\n" + .'- {MediaId}：媒资ID。'."\n" + .'- {JobId}：转码子任务ID。'."\n" + .'- {MediaBucket}：媒资ID所在的Bucket。'."\n" + .'- {ExtName}：文件后缀，取转码模板的输出格式。'."\n" + .'- {DestMd5}：转码输出文件的MD5值。 '."\n" + .' 说明： '."\n" + .'1. 该参数必须包含{MediaId} 和 {JobId} 两个占位符。'."\n" + .'2. 输出的Bucket与MediaId所在Bucket相同。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", + ], + ], + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '任务调度信息', + 'description' => '任务调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '转码任务任务状态 - Init: 已提交, Processing: 转码中, Success: 转码成功, Fail: 转码失败, Deleted: 已删除', + 'description' => '转码任务状态 '."\n" + ."\n" + .'- Init：已提交'."\n" + .'- Processing：转码中'."\n" + .'- Success：转码成功'."\n" + .'- Fail：转码失败'."\n" + .'- Deleted：已删除', + 'type' => 'string', + 'example' => 'Init', + ], + 'OutFileMeta' => [ + 'title' => '任务生成视频 Media 信息', + 'description' => '任务生成视频 Media 信息。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资 ID。', + 'type' => 'string', + 'example' => '73e07de0f77171eca3fc7035d0b26402', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。取值：source_file, transcode_file', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitResultJson' => [ + 'title' => '任务提交结果', + 'description' => '任务提交结果。', + 'type' => 'object', + 'example' => '{}', + ], + 'SubmitTime' => [ + 'title' => '任务提交时间', + 'description' => '任务提交时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '提交任务时请求 ID', + 'description' => '提交任务时请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'Name' => [ + 'title' => '任务名。', + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'transcode-job', + ], + 'RequestId' => [ + 'title' => '提交任务时请求 ID。', + 'description' => '提交任务时请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'ParentJobId' => [ + 'title' => '主任务 ID。', + 'description' => '主任务 ID。', + 'type' => 'string', + 'example' => '8b2198504dd340b7b3c9842a74fc9baa', + ], + 'JobCount' => [ + 'title' => '子任务数量。', + 'description' => '子任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', + 'description' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TriggerSource' => [ + 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'description' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'Percent' => [ + 'title' => '任务完成百分比。', + 'description' => '任务完成百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SubmitTime' => [ + 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'InputGroup' => [ + 'title' => '任务输入组 (目前只支持单个输入)。', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + 'OutputGroup' => [ + 'title' => '任务输出组。', + 'description' => '任务输出组。', + 'type' => 'array', + 'items' => [ + 'description' => '作业输出。', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'ProcessConfig' => [ + 'title' => '任务处理配置', + 'description' => '任务处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' '."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .'- high：针对高分辨率设备。'."\n" + ."\n" + .'默认值：high。', + 'type' => 'string', + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率。'."\n" + .' '."\n" + .'- 取值范围：[10，50000]。'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子。'."\n" + .' '."\n" + .'- 取值范围：[0，51]。'."\n" + .'- 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + ."\n" + .'如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始高度。', + 'type' => 'string', + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率。'."\n" + .' '."\n" + .'- 取值范围：(0,60]。'."\n" + .'- 当输入文件帧率超过60时取60。'."\n" + .'- 默认值：取输入文件帧率。', + 'type' => 'string', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数。'."\n" + .' '."\n" + .'- 取值范围：[1，1080000]。'."\n" + .'- 默认值：250。', + 'type' => 'string', + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切。'."\n" + .' 支持2种方式。'."\n" + .' '."\n" + .'- 自动检测黑边并裁切，设置为“border”'."\n" + .'- 自定义裁切，参数格式：width:height:left:top。'."\n" + .'示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边。'."\n" + .' '."\n" + .'- 参数格式：width:height:left:top。'."\n" + .'- 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）', + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小。'."\n" + .' '."\n" + .'- 值范围：[1000，128000]'."\n" + .'- 默认值：6000'."\n" + .'- 单位：Kb', + 'type' => 'string', + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值。'."\n" + .' '."\n" + .'- 值范围：[10，50000]'."\n" + .'- 单位：Kbps', + 'type' => 'string', + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）'."\n" + ."\n" + .'- 值范围：[10，50000]'."\n" + .'- 单位：Kbps', + 'type' => 'string', + 'example' => '6000', + ], + ], + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率。'."\n" + .' '."\n" + .'- 默认值：44100 支持22050、32000、44100、48000、96000，'."\n" + .'- 单位：Hz', + 'type' => 'string', + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率。'."\n" + .' '."\n" + .'- 值范围：[8，1000]'."\n" + .'- 单位：Kbps'."\n" + .'- 默认值：128', + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'example' => '2,3', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => '条件转码参数。', + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => '视频转码模式。取值如下：'."\n" + ."\n" + .'- onepass：一般用于ABR。编码速度较twopass更快。'."\n" + ."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + ."\n" + .'- CBR：固定码率模式。'."\n" + ."\n" + .'默认值：onepass。', + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrate' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrate' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：'."\n" + ."\n" + .'- 参数为空，并且codec和输入源不一样：false。'."\n" + ."\n" + .'- 参数为空，并且codec和输入源一样：true。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + ."\n" + .'可选值：rescale、crop、pad、none。'."\n" + ."\n" + .'默认值：none。', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片宽。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片宽的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'example' => '32', + ], + 'Height' => [ + 'title' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'description' => '输出视频上水印图片高。'."\n" + .'值有两种形式：'."\n" + ."\n" + .'- 整数型代水印图片高的像素值。'."\n" + .' - 范围：[8,4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表相对输出视频分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃。', + 'type' => 'string', + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的水平偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围：[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表水平偏移量与输出分辨率宽的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'description' => '水印图片相对输出视频的垂直偏移量。'."\n" + .'默认值：0'."\n" + ."\n" + .'值有两种形式：'."\n" + .'- 整数型代表偏移像素。'."\n" + .' - 范围[8，4096]'."\n" + .' - 单位：px'."\n" + .'- 小数型代表垂直偏移量与输出分辨率高的比率。'."\n" + .' - 范围：(0，1)'."\n" + .' - 支持4位小数，如0.9999，超出部分系统自动丢弃', + 'type' => 'string', + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'description' => '水印的位置。'."\n" + .'- 可取值：TopRight（右上）、TopLeft（左上）、BottomRight（右下）、BottomLeft（左下）'."\n" + .'- 默认值：TopRight', + 'type' => 'string', + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '动态水印，显示时间设置。', + 'description' => '动态水印，显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'description' => '水印开始出现时间。'."\n" + .'- 单位：秒'."\n" + .'- 取值范围：数字'."\n" + .'- 默认值：0', + 'type' => 'string', + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'description' => '水印持续时间。'."\n" + .'- 取值范围：[数字，ToEND]'."\n" + .'- 默认值：ToEND', + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'File' => [ + 'title' => '水印图片文件。', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体。默认：SimSun。', + 'description' => '字体。默认：SimSun。', + 'type' => 'string', + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色。', + 'description' => '颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'description' => '字体透明度。'."\n" + .'- 范围：(0, 1]'."\n" + .'- 默认：1.0', + 'type' => 'string', + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'description' => '文本上边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'Left' => [ + 'title' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'description' => '文本左边距。'."\n" + .'- 默认：0'."\n" + .'- 范围：[0,4096]', + 'type' => 'string', + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'description' => '字体大小。'."\n" + .'- 默认值：16'."\n" + .'- 范围：(4, 120)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'description' => '描边宽度。'."\n" + .'- 默认：0'."\n" + .'- 范围：(0,4096]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'description' => '描边颜色。'."\n" + .'默认：Black'."\n" + .'更多取值请参见BorderColor。', + 'type' => 'string', + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体 size。'."\n" + ."\n" + .'- true: false'."\n" + .'- default: false', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式。', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式。', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件。', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。', + 'type' => 'string', + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + 'KeyServiceType' => [ + 'title' => '密钥服务类型。目前仅支持KMS和Base64', + 'description' => '密钥服务类型。目前仅支持KMS和Base64', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'description' => '多输入合流配置', + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'title' => '用户数据。', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '任务调度配置。', + 'description' => '任务调度配置。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"TranscodeParentJob\\": {\\n \\"TranscodeJobList\\": [\\n {\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobId\\": \\"7d6a7e0d4db2457a8d45ff5d43e1bf0a\\",\\n \\"JobIndex\\": 0,\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"InputUrl\\": \\"oss://bucket/path/to/video.mp4\\\\n\\"\\n }\\n ],\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"测试水印\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/{MediaId}/{JobId}.mp4\\\\n\\"\\n },\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"OutFileMeta\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"73e07de0f77171eca3fc7035d0b26402\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitResultJson\\": {},\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobCount\\": 1,\\n \\"Status\\": \\"Success\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Percent\\": 0,\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"OutputGroup\\": [\\n {\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"测试水印\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\n }\\n }\\n ],\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n }\\n }\\n}","type":"json"}]', + 'title' => '提交转码任务', + 'summary' => '用户可以调用SubmitTranscodeJob接口，指定需要转码的源文件、输出格式以及相关参数，并提交视频或音频文件的转码任务到智能媒体服务。', + 'description' => '该接口将于2025年12月31日下线，请调用[SubmitMediaConvertJob - 提交媒体转码任务](~~2867673~~)。', + ], + 'GetTranscodeJob' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务 ID', + 'description' => '任务 ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '9EDC30DC-0050-5459-B788-F761B2BE359B', + ], + 'TranscodeParentJob' => [ + 'title' => 'TranscodeParentJobWithSubJobDTO', + 'description' => 'TranscodeParentJobWithSubJobDTO', + 'type' => 'object', + 'properties' => [ + 'TranscodeJobList' => [ + 'title' => '子任务列表', + 'description' => '子任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子任务。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '任务创建时间', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'Name' => [ + 'title' => '任务名', + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'transcode-job', + ], + 'ParentJobId' => [ + 'title' => '主任务 ID', + 'description' => '主任务 ID。 ', + 'type' => 'string', + 'example' => '8b2198504dd340b7b3c9842a74fc9baa', + ], + 'JobId' => [ + 'title' => '子任务 ID', + 'description' => '子任务 ID。', + 'type' => 'string', + 'example' => '7d6a7e0d4db2457a8d45ff5d43e1bf0a', + ], + 'JobIndex' => [ + 'title' => '子任务在整个任务中的索引号', + 'description' => '子任务在整个任务中的索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InputGroup' => [ + 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS：OSS文件。'."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'InputUrl' => [ + 'description' => '媒资流地址，只有当对媒资流进行转码时填写此参数。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + 'ProcessConfig' => [ + 'title' => '转码处理配置', + 'description' => '转码处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。'."\n" + .'支持baseline、main、high。'."\n" + .' '."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .' - high：针对高分辨率设备。'."\n" + ."\n" + .'默认值：high。', + 'type' => 'string', + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率。 '."\n" + .'- 取值范围：[10，50000]。'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子。'."\n" + .' '."\n" + .'- 取值范围：[0，51]。'."\n" + .'- 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' '."\n" + .'如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽。'."\n" + .'- 取值范围：[128,4096]。 '."\n" + .'- 单位：px。 '."\n" + .' '."\n" + .'默认值：视频原始宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .' '."\n" + .'默认值：视频原始高度。', + 'type' => 'string', + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率。'."\n" + .' '."\n" + .'- 取值范围：(0,60]。'."\n" + .'当输入文件帧率超过60时取60。'."\n" + .' '."\n" + .'- 默认值：取输入文件帧率。', + 'type' => 'string', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数。'."\n" + .' '."\n" + .'- 取值范围：[1，1080000]。'."\n" + .'- 默认值：250。', + 'type' => 'string', + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + ."\n" + .'默认值：medium。', + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切，支持2种方式：'."\n" + .'- 自动检测黑边并裁切，设置为“border”；'."\n" + .'- 自定义裁切，参数格式：width:height:left:top。', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边，参数格式：width:height:left:top。', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）。', + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小：'."\n" + .'- 值范围：[1000，128000]；'."\n" + .'- 默认值：6000；'."\n" + .'- 单位：Kb。', + 'type' => 'string', + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值：'."\n" + .'- 值范围[10，50000]；'."\n" + .'- 单位Kbps。', + 'type' => 'string', + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）：'."\n" + .'- 值范围[10，50000]；'."\n" + .'- 单位Kbps。', + 'type' => 'string', + 'example' => '6000', + ], + ], + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' '."\n" + .' 默认值：AAC', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率。'."\n" + .' '."\n" + .'- 默认值：44100'."\n" + .'支持22050、32000、44100、48000、96000，'."\n" + .'- 单位：Hz', + 'type' => 'string', + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率。'."\n" + .' '."\n" + .'- 值范围：[8，1000]'."\n" + .'- 单位：Kbps'."\n" + .'- 默认值：128', + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'example' => '2,3', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => '条件转码参数。', + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => '视频转码模式。取值如下：'."\n" + ."\n" + .'- onepass：一般用于ABR。编码速度较twopass更快。'."\n" + ."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + ."\n" + .'- CBR：固定码率模式。'."\n" + ."\n" + .'默认值：onepass。', + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrate' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrate' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：'."\n" + ."\n" + .'- 参数为空，并且codec和输入源不一样：false。'."\n" + ."\n" + .'- 参数为空，并且codec和输入源一样：true。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + ."\n" + .'可选值：rescale、crop、pad、none。'."\n" + ."\n" + .'默认值：none。'."\n" + ."\n" + .'示例：请参见如何设置分辨率。', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + 'Tags' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '32', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印位置，x', + 'description' => '水印位置，x。', + 'type' => 'string', + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印位置，y', + 'description' => '水印位置，y。', + 'type' => 'string', + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', + 'description' => '参考位置：TopLeft, TopRight, BottomLeft, BottomRight '."\n" + .'默认值：TopLeft。', + 'type' => 'string', + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '显示时间设置', + 'description' => '显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '显示时长，秒数 或者 "ToEND"', + 'description' => '显示时长，秒数或者 "ToEND"。', + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'File' => [ + 'title' => '水印图片文件', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体', + 'description' => '字体。', + 'type' => 'string', + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色', + 'description' => '颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '透明度', + 'description' => '透明度。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '水印位置，距离上边距离', + 'description' => '水印位置，距离上边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'Left' => [ + 'title' => '水印位置，距离左边距离', + 'description' => '水印位置，距离左边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小', + 'description' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '边框宽度', + 'description' => '边框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '边框颜色', + 'description' => '边框颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体 size。 true / false, default: false。', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。', + 'type' => 'string', + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + 'KeyServiceType' => [ + 'title' => '密钥服务类型。目前仅支持KMS和Base64', + 'description' => '密钥服务类型。目前仅支持KMS和Base64', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.0', + ], + ], + ], + ], + 'IsInheritTags' => [ + 'description' => '是否继承输入流的tag。'."\n" + .'当输入不是媒资是该参数不生效。'."\n" + .'默认值：false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'OutputUrl' => [ + 'description' => '转码输出流地址，仅当输出到媒资流时需要填此参数', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4'."\n", + ], + ], + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '任务调度信息', + 'description' => '任务调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '转码任务任务状态 - Init: 已提交, Processing: 转码中, Success: 转码成功, Fail: 转码失败, Deleted: 已删除', + 'description' => '转码任务状态 '."\n" + .'- Init：已提交。'."\n" + ."\n" + .'- Processing：转码中。'."\n" + .'- Success：转码成功。'."\n" + ."\n" + .'- Fail：转码失败。'."\n" + ."\n" + .'- Deleted：已删除。', + 'type' => 'string', + 'example' => 'Init', + ], + 'OutFileMeta' => [ + 'title' => '任务生成视频 Media 信息', + 'description' => '任务生成视频 Media 信息。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资 ID。', + 'type' => 'string', + 'example' => '486c2890096871edba6f81848c016303', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。取值：source_file, transcode_file', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0：没有 B 帧, '."\n" + .'- 1：有一个 B 帧, '."\n" + .'- 2：有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitResultJson' => [ + 'title' => '任务提交结果', + 'description' => '任务提交结果。', + 'type' => 'object', + 'example' => '{}', + ], + 'SubmitTime' => [ + 'title' => '任务提交时间', + 'description' => '任务提交时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务结束时间', + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '提交任务时请求 ID', + 'description' => '提交任务时请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'Name' => [ + 'title' => '任务名。', + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'transcode-job', + ], + 'RequestId' => [ + 'title' => '提交任务时请求 ID。', + 'description' => '提交任务时请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'ParentJobId' => [ + 'title' => '主任务 ID。', + 'description' => '主任务 ID。', + 'type' => 'string', + 'example' => '8b2198504dd340b7b3c9842a74fc9baa', + ], + 'JobCount' => [ + 'title' => '子任务数量。', + 'description' => '子任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', + 'description' => '任务状态。 '."\n" + ."\n" + .'- Success: 所有子任务完成后，有一个子任务则为成功,。'."\n" + .'- Fail: 所有子任务失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TriggerSource' => [ + 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'description' => '任务来源。'."\n" + ."\n" + .'- API: API'."\n" + .'- WorkFlow: 工作流'."\n" + .'- Console: 控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'Percent' => [ + 'title' => '任务完成百分比。', + 'description' => '任务完成百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SubmitTime' => [ + 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'InputGroup' => [ + 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '作业输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + 'OutputGroup' => [ + 'title' => '任务输出组。', + 'description' => '任务输出组。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'OutputUrl' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4'."\n", + ], + ], + ], + 'ProcessConfig' => [ + 'title' => '任务处理配置', + 'description' => '任务处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' '."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .'- high：针对高分辨率设备。'."\n" + ."\n" + .'默认值：high。', + 'type' => 'string', + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率。'."\n" + .' '."\n" + .'- 取值范围：[10，50000]。'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子。'."\n" + .' '."\n" + .'- 取值范围：[0，51]。'."\n" + .'- 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .'- 如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高。'."\n" + .' '."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始高度。', + 'type' => 'string', + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率。'."\n" + .' '."\n" + .'- 取值范围：(0,60]。'."\n" + .'- 当输入文件帧率超过60时取60。'."\n" + .'- 默认值：取输入文件帧率。', + 'type' => 'string', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数。'."\n" + .' '."\n" + .'- 取值范围：[1，1080000]。'."\n" + .'- 默认值：250。', + 'type' => 'string', + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边参数'."\n" + .' '."\n" + .'- 格式：width:height:left:top。'."\n" + .'- 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）。', + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小值'."\n" + ."\n" + .'- 取值范围：[1000，128000]'."\n" + .'- 默认值：6000'."\n" + .'- 单位：Kb', + 'type' => 'string', + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值'."\n" + ."\n" + .'- 取值范围：[10，50000]'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）值'."\n" + ."\n" + .'- 取值范围：[10，50000]，'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '6000', + ], + ], + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率。'."\n" + .' '."\n" + .'- 默认值：44100'."\n" + .'- 支持22050、32000、44100、48000、96000，'."\n" + .'- 单位：Hz', + 'type' => 'string', + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率。'."\n" + .' '."\n" + .'- 值范围：[8，1000]'."\n" + .'- 单位：Kbps'."\n" + .'- 默认值：128', + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'example' => '2,3', + ], + ], + ], + ], + ], + 'TransConfig' => [ + 'description' => '条件转码参数。', + 'type' => 'object', + 'properties' => [ + 'TransMode' => [ + 'description' => '视频转码模式。取值如下：'."\n" + ."\n" + .'- onepass：一般用于ABR。编码速度较twopass更快。'."\n" + ."\n" + .'- twopass：一般用于VBR。编码速度较onepass更慢。'."\n" + ."\n" + .'- CBR：固定码率模式。'."\n" + ."\n" + .'默认值：onepass。', + 'type' => 'string', + 'example' => 'onepass', + ], + 'IsCheckReso' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，IsCheckResoFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，按输入视频分辨率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckResoFail' => [ + 'description' => '是否检查视频分辨率。IsCheckReso和IsCheckResoFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频分辨率（宽或高）小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrate' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，IsCheckVideoBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，按输入视频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckVideoBitrateFail' => [ + 'description' => '是否检查视频码率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入视频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrate' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，IsCheckAudioBitrateFail优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，按输入音频码率转码。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：'."\n" + ."\n" + .'- 参数为空，并且codec和输入源不一样：false。'."\n" + ."\n" + .'- 参数为空，并且codec和输入源一样：true。', + 'type' => 'string', + 'example' => 'true', + ], + 'IsCheckAudioBitrateFail' => [ + 'description' => '是否检查音频码率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支持二选一，本参数优先级更高。'."\n" + ."\n" + .'- true：检查。当输入音频码率小于输出设置时，返回转码失败。'."\n" + ."\n" + .'- false：不检查。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'example' => 'true', + ], + 'AdjDarMethod' => [ + 'description' => '分辨率改写方式。当Width或Height都填写时才生效，可以和LongShortMode搭配使用。'."\n" + ."\n" + .'可选值：rescale、crop、pad、none。'."\n" + ."\n" + .'默认值：none。', + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '32', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印位置，x', + 'description' => '水印位置，x。', + 'type' => 'string', + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印位置，y', + 'description' => '水印位置，y。', + 'type' => 'string', + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', + 'description' => '参考位置：TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft。', + 'type' => 'string', + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '显示时间设置', + 'description' => '显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '显示时长，秒数 或者 "ToEND"', + 'description' => '显示时长，秒数或者 "ToEND"。', + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'File' => [ + 'title' => '水印图片文件', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体', + 'description' => '字体。', + 'type' => 'string', + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色', + 'description' => '颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '透明度', + 'description' => '透明度。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '水印位置，距离上边距离', + 'description' => '水印位置，距离上边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'Left' => [ + 'title' => '水印位置，距离左边距离', + 'description' => '水印位置，距离左边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小', + 'description' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '边框宽度', + 'description' => '边框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '边框颜色', + 'description' => '边框颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体 size。 true / false, default: false。', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18d410', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。', + 'type' => 'string', + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + 'KeyServiceType' => [ + 'title' => '密钥服务类型。目前仅支持KMS和Base64', + 'description' => '密钥服务类型。目前仅支持KMS和Base64', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'title' => '用户数据。', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '任务调度配置。', + 'description' => '任务调度配置。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9EDC30DC-0050-5459-B788-F761B2BE359B\\",\\n \\"TranscodeParentJob\\": {\\n \\"TranscodeJobList\\": [\\n {\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobId\\": \\"7d6a7e0d4db2457a8d45ff5d43e1bf0a\\",\\n \\"JobIndex\\": 0,\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"InputUrl\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n },\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"测试水印\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ],\\n \\"IsInheritTags\\": true\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/{MediaId}/{JobId}.mp4\\\\n\\"\\n },\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"OutFileMeta\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"486c2890096871edba6f81848c016303\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitResultJson\\": {},\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc9baa\\",\\n \\"JobCount\\": 1,\\n \\"Status\\": \\"Success\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Percent\\": 0,\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"OutputGroup\\": [\\n {\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/video.mp4\\\\n\\"\\n },\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"TransConfig\\": {\\n \\"TransMode\\": \\"onepass\\",\\n \\"IsCheckReso\\": \\"true\\",\\n \\"IsCheckResoFail\\": \\"true\\",\\n \\"IsCheckVideoBitrate\\": \\"true\\",\\n \\"IsCheckVideoBitrateFail\\": \\"true\\",\\n \\"IsCheckAudioBitrate\\": \\"true\\",\\n \\"IsCheckAudioBitrateFail\\": \\"true\\",\\n \\"AdjDarMethod\\": \\"none\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"测试水印\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18d410\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\",\\n \\"KeyServiceType\\": \\"KMS\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ]\\n }\\n }\\n ],\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询转码任务', + 'summary' => '查询单个转码任务详情。', + 'description' => '该接口将于2025年12月31日下线，请调用[GetMediaConvertJob - 查询媒体转码任务](~~2867675~~)。', + ], + 'ListTranscodeJobs' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-15T00:00:00Z', + ], + ], + [ + 'name' => 'ParentJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '按 jobId 筛选。', + 'description' => '按jobId筛选。', + 'type' => 'string', + 'required' => false, + 'example' => '7b38a5d86f1e47838927b6e7ccb1****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + .'- Init：已提交。'."\n" + .'- Success：成功。'."\n" + .'- Fail：失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', + 'description' => '排序顺序。目前只支持两种：'."\n" + .'- CreateTimeDesc：按创建时间降序和。'."\n" + .'- CreateTimeAsc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。范围: 0~100，默认值：20。', + 'description' => '分页大小。范围：0~100，默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记 (第一页没有)。', + 'description' => '连续分页查询时下一页的标记（第一页没有）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 id', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'Jobs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'Name' => [ + 'title' => '任务名。', + 'description' => '任务名。', + 'type' => 'string', + 'example' => 'transcode-job', + ], + 'RequestId' => [ + 'title' => '提交任务时请求 ID。', + 'description' => '提交任务时请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'ParentJobId' => [ + 'title' => '主任务 ID。', + 'description' => '主任务 ID。', + 'type' => 'string', + 'example' => '8b2198504dd340b7b3c9842a74fc****', + ], + 'JobCount' => [ + 'title' => '子任务数量。', + 'description' => '子任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'title' => '任务状态。 Success: 所有子任务完成后，有一个子任务则为成功, Fail: 所有子任务失败', + 'description' => '任务状态。 '."\n" + .'- Success：所有子任务完成后，有一个子任务则为成功。 '."\n" + .'- Fail：所有子任务失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'TriggerSource' => [ + 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'description' => '任务来源。 '."\n" + ."\n" + .'- API：API。'."\n" + .'- WorkFlow：工作流, '."\n" + .'- Console：控制台。', + 'type' => 'string', + 'example' => 'API', + ], + 'Percent' => [ + 'title' => '任务完成百分比。', + 'description' => '任务完成百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SubmitTime' => [ + 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'InputGroup' => [ + 'title' => '任务输入组。单输入时为转码任务，多输入时为合流任务。', + 'description' => '任务输入组。单个输入为转码任务。多个输入为音视频合流任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS：OSS文件。'."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为OSS时，URL支持OSS协议和 HTTP 协议。'."\n" + .'- type 为Media时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'InputUrl' => [ + 'description' => '媒资流地址，只有当对媒资流进行转码时填写此参数。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + 'OutputGroup' => [ + 'title' => '任务输出组。', + 'description' => '任务输出组。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出媒体配置', + 'description' => '输出媒体配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为OSS时，URL支持OSS协议和 HTTP 协议。'."\n" + ."\n" + .'- type 为Media时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + 'OutputUrl' => [ + 'description' => '转码输出流地址，仅当输出到媒资流时需要填此参数', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/{MediaId}/{JobId}.mp4', + ], + ], + ], + 'ProcessConfig' => [ + 'title' => '任务处理配置', + 'description' => '任务处理配置。', + 'type' => 'object', + 'properties' => [ + 'Transcode' => [ + 'title' => '转码配置', + 'description' => '转码配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18****', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Video' => [ + 'title' => 'video 设置', + 'description' => 'video 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '编码格式', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Profile' => [ + 'title' => '编码级别。'."\n" + .' 支持baseline、main、high。'."\n" + .' baseline：针对移动设备。'."\n" + .' main：针对标准分辨率设备。'."\n" + .' high：针对高分辨率设备。'."\n" + .' 默认值：high。', + 'description' => '编码级别。支持baseline、main、high。'."\n" + .'- baseline：针对移动设备。'."\n" + .'- main：针对标准分辨率设备。'."\n" + .'- high：针对高分辨率设备。'."\n" + ."\n" + .'默认值：high。', + 'type' => 'string', + 'example' => 'Main', + ], + 'Bitrate' => [ + 'title' => '视频平均码率。'."\n" + .' 取值范围：[10，50000]。'."\n" + .' 单位：Kbps。', + 'description' => '视频平均码率。'."\n" + ."\n" + .'- 取值范围：[10，50000]。'."\n" + .'- 单位：Kbps。', + 'type' => 'string', + 'example' => '3000', + ], + 'Crf' => [ + 'title' => '码率-质量控制因子。'."\n" + .' 取值范围：[0，51]。'."\n" + .' 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + .' 如果设置了Crf，则Bitrate的设置失效。', + 'description' => '码率-质量控制因子。'."\n" + ."\n" + .'- 取值范围：[0，51]。'."\n" + .'- 默认值：编码格式为H264，默认值为23。编码格式为H265，默认值为26。'."\n" + ."\n" + .'如果设置了Crf，则Bitrate的设置失效。', + 'type' => 'string', + 'example' => '23', + ], + 'Width' => [ + 'title' => '宽。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始宽度。', + 'description' => '宽。'."\n" + ."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始宽度。', + 'type' => 'string', + 'example' => '1920', + ], + 'Height' => [ + 'title' => '高。'."\n" + .' 取值范围：[128,4096]。'."\n" + .' 单位：px。'."\n" + .' 默认值：视频原始高度。', + 'description' => '高。'."\n" + ."\n" + .'- 取值范围：[128,4096]。'."\n" + .'- 单位：px。'."\n" + .'- 默认值：视频原始高度。', + 'type' => 'string', + 'example' => '1080', + ], + 'Fps' => [ + 'title' => '帧率。'."\n" + .' 取值范围：(0,60]。'."\n" + .' 当输入文件帧率超过60时取60。'."\n" + .' 默认值：取输入文件帧率', + 'description' => '帧率。'."\n" + ."\n" + .'- 取值范围：(0,60]。'."\n" + .'- 当输入文件帧率超过60时取60。'."\n" + .'- 默认值：取输入文件帧率。', + 'type' => 'string', + 'example' => '25', + ], + 'Gop' => [ + 'title' => '关键帧间最大帧数。'."\n" + .' 取值范围：[1，1080000]。'."\n" + .' 默认值：250。', + 'description' => '关键帧间最大帧数。'."\n" + ."\n" + .'- 取值范围：[1，1080000]。'."\n" + .'- 默认值：250。', + 'type' => 'string', + 'example' => '250', + ], + 'Preset' => [ + 'title' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'description' => '视频算法器预置。只有H264支持该参数。'."\n" + .'支持veryfast、fast、medium、slow、slower。'."\n" + .'默认值：medium。', + 'type' => 'string', + 'example' => 'medium', + ], + 'ScanMode' => [ + 'title' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'description' => '扫描模式。'."\n" + .'支持interlaced、progressive。', + 'type' => 'string', + 'example' => 'progressive', + ], + 'PixFmt' => [ + 'title' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'description' => '视频颜色格式。'."\n" + .' 范围：yuv420p，yuvj420p等标准颜色格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Remove' => [ + 'title' => '是否去掉视频', + 'description' => '是否去掉视频。', + 'type' => 'string', + 'example' => 'false', + ], + 'Crop' => [ + 'title' => '视频画面裁切'."\n" + .' 支持2种方式。'."\n" + .' 自动检测黑边并裁切，设置为“border”'."\n" + .' 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频画面裁切。'."\n" + .' 支持2种方式。'."\n" + .' '."\n" + .'- 自动检测黑边并裁切，设置为“border”'."\n" + .'- 自定义裁切，参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'Pad' => [ + 'title' => '视频贴黑边'."\n" + .' 参数格式：width:height:left:top。'."\n" + .' 示例：1280:800:0:140', + 'description' => '视频贴黑边。'."\n" + ."\n" + .'- 参数格式：width:height:left:top。'."\n" + .'- 示例：1280:800:0:140', + 'type' => 'string', + 'example' => '1280:800:0:140', + ], + 'LongShortMode' => [ + 'title' => '是否开启横竖屏自适应（即：长短边模式）', + 'description' => '是否开启横竖屏自适应（即：长短边模式）', + 'type' => 'string', + 'example' => 'false', + ], + 'Bufsize' => [ + 'title' => '缓冲区大小'."\n" + .' 值范围：[1000，128000]'."\n" + .' 默认值：6000'."\n" + .' 单位：Kb', + 'description' => '缓冲区大小。'."\n" + ."\n" + .'- 值范围：[1000，128000]'."\n" + .'- 默认值：6000'."\n" + .'- 单位：Kb', + 'type' => 'string', + 'example' => '6000', + ], + 'Maxrate' => [ + 'title' => '视频码率峰值'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'description' => '视频码率峰值。'."\n" + .' 值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'example' => '9000', + ], + 'AbrMax' => [ + 'title' => 'abr 最大码率(只有窄高1有效)'."\n" + .'值范围[10，50000]，单位Kbps。', + 'description' => 'abr 最大码率（只有窄高1有效）'."\n" + .'值范围[10，50000]，单位Kbps。', + 'type' => 'string', + 'example' => '6000', + ], + ], + ], + 'Audio' => [ + 'title' => 'audio 设置', + 'description' => 'audio 设置。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'title' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'description' => '音频编解码格式，AAC、MP3、VORBIS、FLAC。'."\n" + .' 默认值：AAC', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Profile' => [ + 'title' => '音频编码预置。'."\n" + .' 当Codec为 AAC时，范围aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'description' => '音频编码的预置配置。当Codec为 AAC时，预置值取值范围：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。', + 'type' => 'string', + 'example' => 'aac_low', + ], + 'Samplerate' => [ + 'title' => '采样率。'."\n" + .' 默认值：44100'."\n" + .' 支持22050、32000、44100、48000、96000，'."\n" + .' 单位：Hz', + 'description' => '采样率。'."\n" + ."\n" + .'- 默认值：44100'."\n" + .'- 支持22050、32000、44100、48000、96000，'."\n" + .'- 单位：Hz', + 'type' => 'string', + 'example' => '44100', + ], + 'Bitrate' => [ + 'title' => '输出文件的音频码率。'."\n" + .' 值范围：[8，1000]'."\n" + .' 单位：Kbps'."\n" + .' 默认值：128', + 'description' => '输出文件的音频码率。'."\n" + ."\n" + .'- 值范围：[8，1000]'."\n" + .'- 单位：Kbps'."\n" + .'- 默认值：128', + 'type' => 'string', + 'example' => '128', + ], + 'Channels' => [ + 'title' => '声道数。'."\n" + .' 默认值：2', + 'description' => '声道数。'."\n" + .' 默认值：2', + 'type' => 'string', + 'example' => '2', + ], + 'Remove' => [ + 'title' => '是否删除音频流。', + 'description' => '是否删除音频流。', + 'type' => 'string', + 'example' => 'false', + ], + 'Volume' => [ + 'title' => '音量控制', + 'description' => '音量控制。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => '音量调整方式', + 'description' => '音量调整方式。', + 'type' => 'string', + 'example' => 'auto', + ], + 'IntegratedLoudnessTarget' => [ + 'title' => '目标音量', + 'description' => '目标音量。', + 'type' => 'string', + 'example' => '-6', + ], + 'TruePeak' => [ + 'title' => '最大峰值', + 'description' => '最大峰值。', + 'type' => 'string', + 'example' => '-1', + ], + 'LoudnessRangeTarget' => [ + 'title' => '音量范围', + 'description' => '音量范围。', + 'type' => 'string', + 'example' => '8', + ], + ], + ], + ], + ], + 'Container' => [ + 'title' => '封装格式设置', + 'description' => '封装格式设置。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '容器格式', + 'description' => '容器格式。', + 'type' => 'string', + 'example' => 'mp4', + ], + ], + ], + 'MuxConfig' => [ + 'title' => '封装设置', + 'description' => '封装设置。', + 'type' => 'object', + 'properties' => [ + 'Segment' => [ + 'title' => '切片设置', + 'description' => '切片设置。', + 'type' => 'object', + 'properties' => [ + 'Duration' => [ + 'title' => '切片时长', + 'description' => '切片时长。', + 'type' => 'string', + 'example' => '10', + ], + 'ForceSegTime' => [ + 'title' => '强制切片时间点', + 'description' => '强制切片时间点。', + 'type' => 'string', + 'example' => '2,3', + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'ImageWatermarks' => [ + 'title' => '图片水印配置', + 'description' => '图片水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '图片水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18****', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '32', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '32', + ], + 'Dx' => [ + 'title' => '水印位置，x', + 'description' => '水印位置，x', + 'type' => 'string', + 'example' => '10', + ], + 'Dy' => [ + 'title' => '水印位置，y', + 'description' => '水印位置，y', + 'type' => 'string', + 'example' => '10', + ], + 'ReferPos' => [ + 'title' => '参考位置: TopLeft, TopRight, BottomLeft, BottomRight default: TopLeft', + 'description' => '参考位置：TopLeft, TopRight, BottomLeft, BottomRight '."\n" + .'默认值：TopLeft', + 'type' => 'string', + 'example' => 'TopLeft', + ], + 'Timeline' => [ + 'title' => '显示时间设置', + 'description' => '显示时间设置。', + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '00:00:05', + ], + 'Duration' => [ + 'title' => '显示时长，秒数 或者 "ToEND"', + 'description' => '显示时长，秒数或者 "ToEND"', + 'type' => 'string', + 'example' => 'ToEND', + ], + ], + ], + 'File' => [ + 'title' => '水印图片文件', + 'description' => '水印图片文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' '."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'TextWatermarks' => [ + 'title' => '文字水印配置', + 'description' => '文字水印配置。', + 'type' => 'array', + 'items' => [ + 'description' => '文字水印配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18****', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码', + 'description' => '水印文本，不需要 base64 encode，字符串需要 utf-8 编码。', + 'type' => 'string', + 'example' => '测试水印', + ], + 'FontName' => [ + 'title' => '字体', + 'description' => '字体。', + 'type' => 'string', + 'example' => 'SimSun', + ], + 'FontColor' => [ + 'title' => '颜色', + 'description' => '颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'FontAlpha' => [ + 'title' => '透明度', + 'description' => '透明度。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Top' => [ + 'title' => '水印位置，距离上边距离', + 'description' => '水印位置，距离上边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'Left' => [ + 'title' => '水印位置，距离左边距离', + 'description' => '水印位置，距离左边距离。', + 'type' => 'string', + 'example' => '10', + ], + 'FontSize' => [ + 'title' => '字体大小', + 'description' => '字体大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'BorderWidth' => [ + 'title' => '边框宽度', + 'description' => '边框宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BorderColor' => [ + 'title' => '边框颜色', + 'description' => '边框颜色。', + 'type' => 'string', + 'example' => '#006400', + ], + 'Adaptive' => [ + 'title' => '根据输出视频大小调整字体 size。 true / false, default: false', + 'description' => '根据输出视频大小调整字体size。'."\n" + ."\n" + .'- true：系统会根据输出视频的大小自动调整文本的字体大小。'."\n" + ."\n" + .' - false：字体大小将保持固定，不受输出视频大小的影响。'."\n" + ."\n" + .'默认值：false', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'Subtitles' => [ + 'title' => '字幕压制配置', + 'description' => '字幕压制配置。', + 'type' => 'array', + 'items' => [ + 'description' => '字幕压制配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板 ID。', + 'description' => '模板 ID。', + 'type' => 'string', + 'example' => '9547c6ad97cb4f2aaa29683ebd18****', + ], + 'OverwriteParams' => [ + 'title' => '覆盖参数, 若填写会覆盖模板对应参数', + 'description' => '覆盖参数, 若填写会覆盖模板对应参数。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '字幕文件格式', + 'description' => '字幕文件格式。', + 'type' => 'string', + 'example' => 'vtt', + ], + 'CharEnc' => [ + 'title' => '文件 encoding 格式', + 'description' => '文件 encoding 格式。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'File' => [ + 'title' => '字幕文件', + 'description' => '字幕文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS：OSS文件。'."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + ], + ], + 'Encryption' => [ + 'title' => '加密配置。', + 'description' => '加密配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptType' => [ + 'title' => '加密类型。', + 'description' => '加密类型。', + 'type' => 'string', + 'example' => 'PrivateEncryption', + ], + 'CipherText' => [ + 'title' => '标准加密的密钥密文。', + 'description' => '标准加密的密钥密文。', + 'type' => 'string', + 'example' => 'MTYi00NDU0LTg5O****', + ], + 'DecryptKeyUri' => [ + 'title' => '标准加密的解密服务地址。', + 'description' => '标准加密的解密服务地址。', + 'type' => 'string', + 'example' => 'https://sample.com/path?CipherText=MTYi00NDU0LTg5O****', + ], + ], + ], + 'CombineConfigs' => [ + 'title' => '多输入合流配置', + 'description' => '多输入合流配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AudioIndex' => [ + 'title' => '音频流Index', + 'description' => '音频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'VideoIndex' => [ + 'title' => '视频流Index', + 'description' => '视频流Index', + 'type' => 'string', + 'required' => true, + 'example' => '0 或 exclude', + ], + 'Start' => [ + 'title' => '输入流的开始时间。 默认为0', + 'description' => '输入流的开始时间。 默认为0', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.0', + ], + 'Duration' => [ + 'title' => '输入流的持续时间。 默认为视频时长。', + 'description' => '输入流的持续时间。 默认为视频时长。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.0', + ], + ], + ], + ], + 'IsInheritTags' => [ + 'description' => '是否继承输入流的 tag。 当输入不是媒资是该参数不生效。 默认值：false', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'UserData' => [ + 'title' => '用户数据。', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '任务调度配置。', + 'description' => '任务调度配置。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f****', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + 'NextPageToken' => [ + 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'description' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'type' => 'string', + 'example' => '019daf5780f74831b0e1a767c9f1****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Jobs\\": [\\n {\\n \\"CreateTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"Name\\": \\"transcode-job\\",\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"ParentJobId\\": \\"8b2198504dd340b7b3c9842a74fc****\\",\\n \\"JobCount\\": 1,\\n \\"Status\\": \\"Success\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Percent\\": 0,\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"InputGroup\\": [\\n {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"InputUrl\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n ],\\n \\"OutputGroup\\": [\\n {\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\",\\n \\"OutputUrl\\": \\"oss://bucket/path/to/{MediaId}/{JobId}.mp4\\"\\n },\\n \\"ProcessConfig\\": {\\n \\"Transcode\\": {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Video\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Profile\\": \\"Main\\",\\n \\"Bitrate\\": \\"3000\\",\\n \\"Crf\\": \\"23\\",\\n \\"Width\\": \\"1920\\",\\n \\"Height\\": \\"1080\\",\\n \\"Fps\\": \\"25\\",\\n \\"Gop\\": \\"250\\",\\n \\"Preset\\": \\"medium\\",\\n \\"ScanMode\\": \\"progressive\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Remove\\": \\"false\\",\\n \\"Crop\\": \\"1280:800:0:140\\",\\n \\"Pad\\": \\"1280:800:0:140\\",\\n \\"LongShortMode\\": \\"false\\",\\n \\"Bufsize\\": \\"6000\\",\\n \\"Maxrate\\": \\"9000\\",\\n \\"AbrMax\\": \\"6000\\"\\n },\\n \\"Audio\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Profile\\": \\"aac_low\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Bitrate\\": \\"128\\",\\n \\"Channels\\": \\"2\\",\\n \\"Remove\\": \\"false\\",\\n \\"Volume\\": {\\n \\"Method\\": \\"auto\\",\\n \\"IntegratedLoudnessTarget\\": \\"-6\\",\\n \\"TruePeak\\": \\"-1\\",\\n \\"LoudnessRangeTarget\\": \\"8\\"\\n }\\n },\\n \\"Container\\": {\\n \\"Format\\": \\"mp4\\"\\n },\\n \\"MuxConfig\\": {\\n \\"Segment\\": {\\n \\"Duration\\": \\"10\\",\\n \\"ForceSegTime\\": \\"2,3\\"\\n }\\n },\\n \\"Tags\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"ImageWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Width\\": \\"32\\",\\n \\"Height\\": \\"32\\",\\n \\"Dx\\": \\"10\\",\\n \\"Dy\\": \\"10\\",\\n \\"ReferPos\\": \\"TopLeft\\",\\n \\"Timeline\\": {\\n \\"Start\\": \\"00:00:05\\",\\n \\"Duration\\": \\"ToEND\\"\\n },\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"TextWatermarks\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Content\\": \\"测试水印\\",\\n \\"FontName\\": \\"SimSun\\",\\n \\"FontColor\\": \\"#006400\\",\\n \\"FontAlpha\\": \\"1.0\\",\\n \\"Top\\": \\"10\\",\\n \\"Left\\": \\"10\\",\\n \\"FontSize\\": 16,\\n \\"BorderWidth\\": 0,\\n \\"BorderColor\\": \\"#006400\\",\\n \\"Adaptive\\": \\"false\\"\\n }\\n }\\n ],\\n \\"Subtitles\\": [\\n {\\n \\"TemplateId\\": \\"9547c6ad97cb4f2aaa29683ebd18****\\",\\n \\"OverwriteParams\\": {\\n \\"Format\\": \\"vtt\\",\\n \\"CharEnc\\": \\"UTF-8\\",\\n \\"File\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n }\\n ],\\n \\"Encryption\\": {\\n \\"EncryptType\\": \\"PrivateEncryption\\",\\n \\"CipherText\\": \\"MTYi00NDU0LTg5O****\\",\\n \\"DecryptKeyUri\\": \\"https://sample.com/path?CipherText=MTYi00NDU0LTg5O****\\"\\n },\\n \\"CombineConfigs\\": [\\n {\\n \\"AudioIndex\\": \\"0 或 exclude\\",\\n \\"VideoIndex\\": \\"0 或 exclude\\",\\n \\"Start\\": 0,\\n \\"Duration\\": 20\\n }\\n ],\\n \\"IsInheritTags\\": true\\n }\\n }\\n ],\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f****\\",\\n \\"Priority\\": 5\\n }\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1****\\"\\n}","type":"json"}]', + 'title' => '查询转码任务列表', + 'summary' => '查询媒体文件的转码任务列表。', + ], + 'SubmitPackageJob' => [ + 'summary' => '提交打包任务接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'Inputs', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务输入。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'title' => '打包播放流文件信息', + 'description' => '打包播放流文件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type为OSS 时，输入源为URL，且支持 OSS 协议和 HTTP 协议。'."\n" + ."\n" + .'- type为Media时，输入源为为媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type为OSS 时，media为URL，且支持 OSS 协议和 HTTP 协议。'."\n" + .' '."\n" + .'- type为Media 时，media为媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度配置。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"param": "value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 id', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'JobId' => [ + 'title' => '打包任务ID', + 'description' => '打包任务ID', + 'type' => 'string', + 'example' => '2d705f385b704ee5b*******a36d93e0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"JobId\\": \\"2d705f385b704ee5b*******a36d93e0\\"\\n}","type":"json"}]', + 'title' => '提交打包任务', + ], + 'GetPackageJob' => [ + 'summary' => '获取单个打包任务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务 ID', + 'description' => '任务ID。可以从[提交打包任务](~~461964~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'PackageJob' => [ + 'title' => '打包任务信息', + 'description' => '打包任务信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + 'TriggerSource' => [ + 'description' => '任务来源。'."\n" + .'- API：API'."\n" + .'- WorkFlow：工作流'."\n" + .'- Console：控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'Inputs' => [ + 'description' => '任务输入。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'title' => '打包播放流文件信息', + 'description' => '打包播放流文件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.m3u8', + ], + ], + ], + 'OutputUrl' => [ + 'description' => '输出文件地址。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8', + ], + 'PipelineId' => [ + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => '36f3fee40aa047c0b067d0fb85ed****', + ], + 'Priority' => [ + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'Init', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Resource content bad.', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-09-08T11:34:05Z', + ], + 'FinishTime' => [ + 'description' => '任务结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-09-08T11:44:05Z', + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"param": "value"}', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-09-08T11:34:05Z'."\n", + ], + 'ModifiedTime' => [ + 'description' => '最后一次修改时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-09-08T11:44:05Z'."\n", + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"PackageJob\\": {\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82df****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"job-name\\",\\n \\"Inputs\\": [\\n {\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.m3u8\\"\\n },\\n \\"OutputUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8\\",\\n \\"PipelineId\\": \\"36f3fee40aa047c0b067d0fb85ed****\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Init\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"Resource content bad.\\",\\n \\"SubmitTime\\": \\"2022-09-08T11:34:05Z\\",\\n \\"FinishTime\\": \\"2022-09-08T11:44:05Z\\",\\n \\"UserData\\": \\"{\\\\\\"param\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-09-08T11:34:05Z\\\\n\\",\\n \\"ModifiedTime\\": \\"2022-09-08T11:44:05Z\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '获取单个打包任务信息', + ], + 'ListPackageJobs' => [ + 'summary' => '获取打包任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-15T00:00:00Z', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '按 jobId 筛选。', + 'description' => '按jobId筛选。', + 'type' => 'string', + 'required' => false, + 'example' => '7b38a5d86f1e47838927b6e7ccb1****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态。'."\n" + ."\n" + .'- Init：已提交'."\n" + .'- Success：成功'."\n" + .'- Fail：失败', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', + 'description' => '排序顺序。目前只支持两种：'."\n" + .'- CreateTimeDesc：按创建时间降序'."\n" + .'- CreateTimeAsc：按创建时间升序', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。范围: 0~100，默认值：20。', + 'description' => '分页大小。范围：0~100，默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记 (第一页没有)。', + 'description' => '连续分页查询时下一页的标记（第一页没有）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'PackageJobList' => [ + 'title' => '打包任务列表', + 'description' => '打包任务列表。', + 'type' => 'object', + 'properties' => [ + 'PackageJobs' => [ + 'description' => '打包任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个打包任务。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '7b38a5d86f1e47838927b6e7ccb1****', + ], + 'TriggerSource' => [ + 'description' => '任务来源。 '."\n" + .'- API：API'."\n" + .'- WorkFlow：工作流'."\n" + .'- Console：控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'Inputs' => [ + 'description' => '任务输入。', + 'type' => 'array', + 'items' => [ + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'title' => '打包播放流文件信息', + 'description' => '打包播放流文件信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS：OSS文件。'."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type为OSS时，为URL，支持OSS协议和 HTTP 协议。'."\n" + ."\n" + .'- type为Media时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => '任务输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type为OSS 时，为URL，支持OSS协议和 HTTP 协议。'."\n" + .'- type为Media时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'PipelineId' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'example' => '5b40833e4c3e4d4e95a866abb9a4****', + ], + 'Priority' => [ + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10。默认为6。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Resource content bad. ', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-07-07T14:00:32Z', + ], + 'FinishTime' => [ + 'description' => '任务结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-07-07T15:00:32Z', + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"param": "value"}', + ], + 'CreateTime' => [ + 'description' => '创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-07-07T14:00:32Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-07-07T15:00:32Z', + ], + ], + ], + ], + 'NextPageToken' => [ + 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'description' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'type' => 'string', + 'example' => '019daf5780f74831b0e1a767c9f1****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"PackageJobList\\": {\\n \\"PackageJobs\\": [\\n {\\n \\"JobId\\": \\"7b38a5d86f1e47838927b6e7ccb1****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"job-name\\",\\n \\"Inputs\\": [\\n {\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n }\\n }\\n ],\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"PipelineId\\": \\"5b40833e4c3e4d4e95a866abb9a4****\\",\\n \\"Priority\\": 6,\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"Resource content bad. \\",\\n \\"SubmitTime\\": \\"2022-07-07T14:00:32Z\\",\\n \\"FinishTime\\": \\"2022-07-07T15:00:32Z\\",\\n \\"UserData\\": \\"{\\\\\\"param\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-07T14:00:32Z\\",\\n \\"ModifiedTime\\": \\"2022-07-07T15:00:32Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1****\\"\\n }\\n}","type":"json"}]', + 'title' => '获取打包任务列表', + ], + 'GenerateKMSDataKey' => [ + 'summary' => '生成一个随机的KMS数据密钥，用于对视频进行标准加密转码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'DataKey' => [ + 'description' => '数据密钥信息。', + 'type' => 'object', + 'properties' => [ + 'KeyId' => [ + 'description' => '主密钥的全局唯一标识符。', + 'type' => 'string', + 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****'."\n", + ], + 'Plaintext' => [ + 'description' => '数据密钥的明文经过Base64编码后的值。', + 'type' => 'string', + 'example' => 'QmFzZTY0IGVuY29kZWQgcGxhaW50****'."\n", + ], + 'CiphertextBlob' => [ + 'description' => '数据密钥被加密后的密文。用于在发起转码时填入CipherText参数。', + 'type' => 'string', + 'example' => ' '."\n" + .'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DataKey\\": {\\n \\"KeyId\\": \\"7906979c-8e06-46a2-be2d-68e3ccbc****\\\\n\\",\\n \\"Plaintext\\": \\"QmFzZTY0IGVuY29kZWQgcGxhaW50****\\\\n\\",\\n \\"CiphertextBlob\\": \\"\\\\t\\\\nODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建KMS数据密钥', + 'description' => '## 前提条件'."\n" + .'您需要提交[工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c63.p38356.0.0.583760760aj80E)创建用户KMS密钥后，再尝试调用本接口。', + ], + 'DecryptKMSDataKey' => [ + 'summary' => '解密KMS数据密钥中的CiphertextBlob密文。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CiphertextBlob', + 'in' => 'query', + 'schema' => [ + 'description' => '待解密的密文。', + 'type' => 'string', + 'required' => true, + 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'DataKey' => [ + 'description' => '解密结果信息。', + 'type' => 'object', + 'properties' => [ + 'KeyId' => [ + 'description' => '解密密文使用的主密钥ID。', + 'type' => 'string', + 'example' => '202b9877-5a25-46e3-a763-e20791b5****'."\n", + ], + 'Plaintext' => [ + 'description' => '解密后的明文。', + 'type' => 'string', + 'example' => 'tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****'."\n", + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"DataKey\\": {\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\\\n\\",\\n \\"Plaintext\\": \\"tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '解密KMS数据密钥密文', + ], + 'SubmitSnapshotJob' => [ + 'summary' => '本接口用于提交截图任务。通过该接口，用户可以指定媒体文件的ID或URL，以及截图的时间点和格式，系统将根据这些参数生成截图并保存到指定的位置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'SampleJob', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '截图输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + ."\n" + .'- OSS：OSS文件地址。'."\n" + ."\n" + .'- Media：媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入媒体。'."\n" + ."\n" + .'- 当Type为OSS时填入OSS地址。'."\n" + ."\n" + .'- Type为Media时填入媒资ID。'."\n" + ."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1. oss://bucket/object'."\n" + ."\n" + .'1. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。'."\n" + ."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '截图输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + ."\n" + .'- OSS：OSS文件地址。'."\n" + ."\n" + .'- Media：媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出媒体。'."\n" + ."\n" + .'- 当Type为OSS时填入OSS地址。'."\n" + ."\n" + .'- Type为Media时填入媒资ID。'."\n" + ."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1. oss://bucket/object'."\n" + ."\n" + .'1. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。'."\n" + ."\n" + .'- 截取多张静态截图时，object必须要带有”{Count}“占位符；'."\n" + ."\n" + .'- 截取雪碧图时，object必须要带有“{TileCount}”占位符。'."\n" + ."\n" + .'- WebVTT截图object的后缀必须是“.vtt”。'."\n" + ."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/output-{Count}.jpg', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '截图模板配置。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****'."\n", + ], + 'OverwriteParams' => [ + 'description' => '覆盖参数。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '截图类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Sprite', + ], + 'FrameType' => [ + 'title' => '截图公共参数', + 'description' => '帧类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'intra', + ], + 'Count' => [ + 'description' => '截图数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'Interval' => [ + 'description' => '截图间隔时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'Time' => [ + 'description' => '截图开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'Width' => [ + 'description' => '输出图片宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + 'Height' => [ + 'description' => '输出图片高度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '480', + ], + 'BlackLevel' => [ + 'description' => '多帧截图针对首帧过滤黑屏图片判定阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'PixelBlackThreshold' => [ + 'description' => '判断像素点是否为黑色点的阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '70', + ], + 'SpriteSnapshotConfig' => [ + 'title' => '雪碧图配置', + 'description' => '雪碧图配置。', + 'type' => 'object', + 'properties' => [ + 'CellWidth' => [ + 'description' => '单图片宽度。默认截图输出分辨率宽度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + 'CellHeight' => [ + 'description' => '单图片高度。默认截图输出分辨率高度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '480', + ], + 'Padding' => [ + 'description' => '图片间距，默认0，单位px', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Margin' => [ + 'description' => '外框宽度，默认0，单位px', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Columns' => [ + 'description' => '图片拼合列数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Lines' => [ + 'description' => '图片拼合行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Color' => [ + 'description' => '背景颜色。', + 'type' => 'string', + 'required' => false, + 'example' => '#000000', + ], + ], + 'required' => false, + ], + 'IsSptFrag' => [ + 'title' => 'Webvtt截图配置:是否拼合输出', + 'description' => 'Webvtt截图配置：是否拼合输出', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度配置', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"test parameter": "test value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<SnapshotJobDTO>', + 'description' => 'PlainResponse<SnapshotJobDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交截图任务', + ], + 'SubmitDynamicImageJob' => [ + 'summary' => '本接口用于提交生成动态图像的任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称', + 'type' => 'string', + 'required' => false, + 'example' => 'SampleJob', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + ."\n" + .'- OSS：OSS文件地址。'."\n" + ."\n" + .'- Media：媒资ID。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss地址', + ], + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体。'."\n" + ."\n" + .'- 当Type为OSS时填入OSS地址。'."\n" + ."\n" + .'- Type为Media时填入媒资ID。'."\n" + ."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1. oss://bucket/object'."\n" + ."\n" + .'1. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。'."\n" + ."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出类型，取值：'."\n" + ."\n" + .'- OSS：oss文件地址。'."\n" + ."\n" + .'- Media：媒资ID。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss地址', + ], + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输出媒体，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为'."\n" + ."\n" + .'- oss://bucket/object'."\n" + .'- http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。'."\n" + ."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '截图模板配置', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****'."\n", + ], + 'OverwriteParams' => [ + 'description' => '覆盖参数', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'description' => '动图格式，取值：'."\n" + .'- gif。'."\n" + .'- webp。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'gif' => 'gif', + 'webp' => 'webp', + ], + 'example' => 'gif', + ], + 'Width' => [ + 'description' => '输出动图宽度。取值范围：[128, 4096]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + 'Height' => [ + 'description' => '输出动图高度。取值范围：[128, 4096]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + 'Fps' => [ + 'description' => '帧率。取值范围：[1, 60]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '15', + ], + 'ScanMode' => [ + 'description' => '扫描模式。可取值：'."\n" + ."\n" + .'- **interlaced**：交叉扫描。'."\n" + ."\n" + .'- **progressive**：顺序扫描。默认值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'progressive' => '顺序扫描', + 'interlaced' => '交叉扫描', + ], + 'example' => 'progressive', + ], + 'LongShortMode' => [ + 'description' => '是否开启横竖屏自适应（长短边模式）。取值：'."\n" + ."\n" + .'- **true**：开启横竖屏自适应。'."\n" + .'- **false**：关闭横竖屏自适应。'."\n" + ."\n" + .'默认值：**true**。'."\n" + .'> 转码输出的宽对应输入片源的长边（竖屏为片源的高），高对应输入视频的短边（竖屏为片源的宽）。'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'TimeSpan' => [ + 'title' => '时间线参数', + 'description' => '时间线参数', + 'type' => 'object', + 'properties' => [ + 'Seek' => [ + 'description' => '开始时间点。 '."\n" + ."\n" + .'- 格式：`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n" + .'- 取值范围 ：`[00:00:00.000,23:59:59.999]`或`[0.000，86399.999]`。', + 'type' => 'string', + 'required' => false, + 'example' => '01:59:59.999 或 32000.23', + ], + 'Duration' => [ + 'description' => '持续时长。'."\n" + .'- 格式：`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n" + .'- 取值范围 ：`[00:00:00.000,23:59:59.999]`或`[0.000，86399.999]`。', + 'type' => 'string', + 'required' => false, + 'example' => '01:59:59.999 或 32000.23', + ], + 'End' => [ + 'description' => '截尾时长，表示切掉尾部的若干时长。设置此值时，参数Duration失效。'."\n" + .'- 格式：`hh:mm:ss[.SSS]`或`sssss[.SSS]`。'."\n" + .'- 取值范围 ：`[00:00:00.000,23:59:59.999]`或`[0.000，86399.999]`。', + 'type' => 'string', + 'required' => false, + 'example' => '01:59:59.999 或 32000.23', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度配置', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****'."\n", + ], + 'Priority' => [ + 'description' => '优先级，1-10，默认6。数值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息', + 'type' => 'string', + 'required' => false, + 'example' => '{"SampleKey": "SampleValue"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<SnapshotJobDTO>', + 'description' => 'PlainResponse<SnapshotJobDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交动图任务', + ], + 'GetSnapshotUrls' => [ + 'summary' => '获取截图任务输出图片的可访问URL。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页数目', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排列顺序。取值：Asc，Desc', + 'description' => '排列顺序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Asc' => '顺序排列', + 'Desc' => '逆序排列', + ], + 'example' => 'Asc', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'title' => '鉴权超时时间', + 'description' => '鉴权超时时间。单位：秒。默认值：3600。最大值：129600（36小时）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Total' => [ + 'title' => '截图总数量', + 'description' => '截图总数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SnapshotUrls' => [ + 'title' => '截图URL', + 'description' => '截图URL列表', + 'type' => 'array', + 'items' => [ + 'description' => '截图URL', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput-00001.jpg', + ], + ], + 'WebVTTUrl' => [ + 'title' => 'WebVTT文件URL', + 'description' => 'WebVTT文件URL', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput.vtt', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Total\\": 30,\\n \\"SnapshotUrls\\": [\\n \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput-00001.jpg\\"\\n ],\\n \\"WebVTTUrl\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/ouoput.vtt\\"\\n}","type":"json"}]', + 'title' => '获取截图任务输出URL', + ], + 'GetSnapshotJob' => [ + 'summary' => '查询截图任务详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '截图任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<SnapshotJobDTO>', + 'description' => 'PlainResponse<SnapshotJobDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SnapshotJob' => [ + 'title' => '截图任务信息', + 'description' => '截图任务信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'TriggerSource' => [ + 'description' => '请求触发来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'Console' => '控制台', + 'Workflow' => '工作流', + 'API' => 'API', + ], + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => '测试任务', + ], + 'Type' => [ + 'description' => '截图类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'WebVtt' => 'WebVTT截图', + 'Sprite' => '雪碧图截图', + 'Normal' => '普通静态截图', + ], + 'example' => 'Sprite', + ], + 'Input' => [ + 'description' => '任务输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://test-bucket/object.mp4', + ], + 'OssFile' => [ + 'title' => '输入类型为媒资ID时的OSS地址', + 'description' => 'OSS三元组', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'Location' => [ + 'description' => 'OSS Location', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Object' => [ + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'object.mp4', + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => '任务输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中，bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。'."\n" + ."\n" + .'- 截取多张静态截图时，object必须要带有”{Count}“占位符；'."\n" + ."\n" + .'- 截取雪碧图时，object必须要带有“{TileCount}”占位符。'."\n" + ."\n" + .'- WebVTT截图object的后缀必须是“.vtt”。', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', + ], + 'OssFile' => [ + 'title' => '输出类型为媒资ID时的OSS地址', + 'description' => 'OSS三元组', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'Location' => [ + 'description' => 'OSS Location', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Object' => [ + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'output-{Count}.jpg', + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '截图数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Async' => [ + 'description' => '是否异步截图。默认：true', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'TemplateConfig' => [ + 'description' => '截图模板配置', + 'type' => 'string', + 'example' => '{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}', + ], + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'The specified resource for "Pipeline" could not be found.', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + 'UserData' => [ + 'description' => '用户自定义参数。', + 'type' => 'string', + 'example' => '{"test parameter": "test value"}', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SnapshotJob\\": {\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"测试任务\\",\\n \\"Type\\": \\"Sprite\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://test-bucket/object.mp4\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"object.mp4\\"\\n }\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"output-{Count}.jpg\\"\\n }\\n },\\n \\"Count\\": 8,\\n \\"Async\\": true,\\n \\"TemplateId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Type\\\\\\":\\\\\\"Normal\\\\\\",\\\\\\"FrameType\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"Time\\\\\\":0,\\\\\\"Count\\\\\\":10}\\",\\n \\"PipelineId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource for \\\\\\"Pipeline\\\\\\" could not be found.\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"UserData\\": \\"{\\\\\\"test parameter\\\\\\": \\\\\\"test value\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n}","type":"json"}]', + 'title' => '查询截图任务详细信息', + ], + 'GetDynamicImageJob' => [ + 'summary' => '查询动图任务详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '动图任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<DynamicImageJobDTO>', + 'description' => 'PlainResponse<DynamicImageJobDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******36-3C1E-4417-BDB2-1E034F******', + ], + 'DynamicImageJob' => [ + 'title' => '截图任务信息', + 'description' => '截图任务信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****'."\n", + ], + 'TriggerSource' => [ + 'description' => '请求触发来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'Console' => '控制台', + 'Workflow' => '工作流', + 'API' => 'API', + ], + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'SampleJob', + ], + 'Input' => [ + 'description' => '任务输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss文件地址', + ], + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. OSS://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://test-bucket/sample-input.mp4', + ], + 'OssFile' => [ + 'title' => '输入类型为媒资ID时的OSS地址', + 'description' => 'OSS三元组', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'Location' => [ + 'description' => 'OSS Location', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Object' => [ + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'sample-input.mp4', + ], + ], + ], + ], + ], + 'Output' => [ + 'description' => '任务输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'OSS：oss文件地址'."\n" + .'Media：媒资ID', + 'type' => 'string', + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss文件地址', + ], + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. OSS://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'OssFile' => [ + 'title' => '输出类型为媒资ID时的OSS地址', + 'description' => 'OSS三元组', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'sample-bucket', + ], + 'Location' => [ + 'description' => 'OSS Location', + 'type' => 'string', + 'example' => 'oss-cn-shanghai', + ], + 'Object' => [ + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'path/to/object', + ], + ], + ], + ], + ], + 'OutputUrl' => [ + 'description' => '输出动图的URL地址', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif', + ], + 'TemplateConfig' => [ + 'description' => '动图模板配置', + 'type' => 'string', + 'example' => '{"Format":"gif","Fps":5,"Height":1080,"Width":1920}', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => 'ResourceNotFound', + ], + 'Message' => [ + 'description' => '错误消息', + 'type' => 'string', + 'example' => 'The specified resource for "CustomTemplate" could not be found.', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + 'UserData' => [ + 'description' => '用户自定义数据', + 'type' => 'string', + 'example' => '{"sampleParam": "sampleValue"}', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'description' => '最后一次修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"DynamicImageJob\\": {\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\\\n\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://test-bucket/sample-input.mp4\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"sample-input.mp4\\"\\n }\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"****d80e4e4044975745c14b****\\",\\n \\"OssFile\\": {\\n \\"Bucket\\": \\"sample-bucket\\",\\n \\"Location\\": \\"oss-cn-shanghai\\",\\n \\"Object\\": \\"path/to/object\\"\\n }\\n },\\n \\"OutputUrl\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output.gif\\",\\n \\"TemplateConfig\\": \\"{\\\\\\"Format\\\\\\":\\\\\\"gif\\\\\\",\\\\\\"Fps\\\\\\":5,\\\\\\"Height\\\\\\":1080,\\\\\\"Width\\\\\\":1920}\\",\\n \\"TemplateId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"PipelineId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"ResourceNotFound\\",\\n \\"Message\\": \\"The specified resource for \\\\\\"CustomTemplate\\\\\\" could not be found.\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"UserData\\": \\"{\\\\\\"sampleParam\\\\\\": \\\\\\"sampleValue\\\\\\"}\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n}","type":"json"}]', + 'title' => '查询动图任务详细信息', + ], + 'ListSnapshotJobs' => [ + 'summary' => '获取截图任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间筛选条件的起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-12T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间筛选条件的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-14T00:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', + 'description' => '排序顺序。取值：'."\n" + .'1. CreateTimeAsc'."\n" + .'2. CreateTimeDesc', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateTimeDesc' => '创建时间逆序排列', + 'CreateTimeAsc' => '创建时间顺序排列', + ], + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记', + 'description' => '连续分页查询时下一页的标记。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Jobs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '截图任务信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'TriggerSource' => [ + 'description' => '请求触发来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'Console' => '控制台', + 'Workflow' => '工作流', + 'API' => 'API', + ], + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'SampleJob', + ], + 'Type' => [ + 'description' => '任务类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'WebVtt' => 'WebVTT截图', + 'Sprite' => '雪碧图截图', + 'Normal' => '普通静态截图', + ], + 'example' => 'Sprite', + ], + 'Input' => [ + 'description' => '任务输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'- OSS://bucket/object'."\n" + ."\n" + .'- http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://bucket/object.mp4', + ], + ], + ], + 'Output' => [ + 'description' => '任务输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'- OSS://bucket/object'."\n" + ."\n" + .'- http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。'."\n" + ."\n" + .'- 截取多张静态截图时，object必须要带有”{Count}“占位符。'."\n" + ."\n" + .'- 截取雪碧图时，object必须要带有“{TileCount}”占位符。'."\n" + ."\n" + .'- WebVTT截图object的后缀必须是“.vtt”。', + 'type' => 'string', + 'example' => 'http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg', + ], + ], + ], + 'Count' => [ + 'description' => '截图数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Async' => [ + 'description' => '是否异步截图', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **Success**：成功'."\n" + ."\n" + .'- **Fail**：失败'."\n" + ."\n" + .'- **Init**：已提交', + 'type' => 'string', + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => '查询下一页标识', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Jobs\\": [\\n {\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Type\\": \\"Sprite\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object.mp4\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg\\"\\n },\\n \\"Count\\": 10,\\n \\"Async\\": true,\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"PipelineId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Success\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '获取截图任务列表', + ], + 'ListDynamicImageJobs' => [ + 'summary' => '获取动图任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间筛选条件的起始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-12T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间筛选条件的结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-14T00:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序：CreateTimeDesc 和 CreateTimeAsc', + 'description' => '排序顺序。取值： '."\n" + .'1. CreateTimeAsc： 按照创建时间顺序排列'."\n" + .'2. CreateTimeDesc： 按照创建时间逆序排列', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateTimeDesc' => '创建时间逆序排列', + 'CreateTimeAsc' => '创建时间顺序排列', + ], + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'required' => false, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记', + 'description' => '连续分页查询时下一页的标记', + 'type' => 'string', + 'required' => false, + 'example' => 'cdb3e74639973036bc84', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResponse<List<DynamicImageJobDTO>>', + 'description' => 'PlainResponse<List<DynamicImageJobDTO>>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Jobs' => [ + 'description' => '任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '动图任务信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '动图任务ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'TriggerSource' => [ + 'description' => '请求触发来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'Console' => '控制台', + 'Workflow' => '工作流', + 'API' => 'API', + ], + 'example' => 'API', + ], + 'Name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'SampleJob', + ], + 'Input' => [ + 'description' => '任务输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss地址', + ], + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为'."\n" + .'1. OSS://bucket/object'."\n" + .'2. http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'Output' => [ + 'description' => '任务输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'enumValueTitles' => [ + 'Media' => '媒资ID', + 'OSS' => 'oss地址', + ], + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. OSS://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的OSS bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- **Success**：成功'."\n" + ."\n" + .'- **Fail**：失败'."\n" + ."\n" + .'- **Init**：已提交', + 'type' => 'string', + 'enumValueTitles' => [ + 'Init' => '已提交', + 'Success' => '成功', + 'Fail' => '失败', + ], + 'example' => 'Success', + ], + 'SubmitTime' => [ + 'description' => '任务提交时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间。', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-07-12T16:17:54Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2022-07-12T16:30:54Z', + ], + ], + ], + ], + 'NextPageToken' => [ + 'description' => '查询下一页标识', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****'."\n", + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Jobs\\": [\\n {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"Name\\": \\"SampleJob\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"****cdb3e74639973036bc84****\\"\\n },\\n \\"TemplateId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"PipelineId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"Status\\": \\"Success\\",\\n \\"SubmitTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"FinishTime\\": \\"2022-07-12T16:30:54Z\\",\\n \\"CreateTime\\": \\"2022-07-12T16:17:54Z\\",\\n \\"ModifiedTime\\": \\"2022-07-12T16:30:54Z\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"****cdb3e74639973036bc84****\\\\n\\"\\n}","type":"json"}]', + 'title' => '获取动图任务列表', + ], + 'SubmitSyncMediaInfoJob' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '139552', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '任务名字', + 'description' => '任务名字。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务输入', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .' - OSS：OSS 文件, '."\n" + .'- Media：媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。'."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。'."\n" + ."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'user-data', + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '调度参数', + 'description' => '调度参数。可不填。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'MediaInfoJob' => [ + 'title' => 'MediaInfoJobDTO', + 'description' => 'MediaInfoJobDTO', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '任务名字。', + 'description' => '任务名字。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'TriggerSource' => [ + 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'description' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'JobId' => [ + 'title' => '任务 ID。', + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + 'Input' => [ + 'title' => '任务输入。', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' '."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'Async' => [ + 'title' => '是否异步处理。', + 'description' => '是否异步处理。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UserData' => [ + 'title' => '用户数据。', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '调度信息。', + 'description' => '调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + .'- Init：已提交'."\n" + ."\n" + .'- Success：成功'."\n" + ."\n" + .'- Fail：失败', + 'type' => 'string', + 'example' => 'Init', + ], + 'SubmitResultJson' => [ + 'title' => '任务提交信息。', + 'description' => '任务提交信息。', + 'type' => 'object', + 'example' => '{}', + ], + 'MediaInfoProperty' => [ + 'title' => '媒体信息详情。', + 'description' => '媒体信息详情。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '999e68259c924f52a6be603cbb3f91cc', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'us', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0：没有 B 帧, '."\n" + .'- 1：有一个 B 帧, '."\n" + .'- 2：有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitTime' => [ + 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"MediaInfoJob\\": {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82dfa8e8\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {},\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"999e68259c924f52a6be603cbb3f91cc\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"us\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n}","type":"json"}]', + 'title' => '提交同步媒体信息任务', + 'summary' => '调用SubmitSyncMediaInfoJob以同步模式提交媒体文件进行媒体信息分析。', + 'description' => '您可以调用本接口以同步模式对输入的文件进行媒体分析，适用于实时性要求较高且并发量较小的场景。'."\n" + .'如果遇到片源获取MediaInfo需要耗时比较久的情况，可能会因请求超时获取不到信息或者信息不准确，推荐通过[SubmitMediaInfoJob - 提交异步媒体信息任务](~~441222~~)接口获取媒体信息。', + ], + 'SubmitMediaInfoJob' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '任务名字', + 'description' => '任务名字。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-name', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '任务输入', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。取值： OSS: OSS文件, Media: 媒资 ID', + 'description' => '媒体对象类型 '."\n" + .'- OSS：oss文件'."\n" + ."\n" + .'- Media：媒资 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。'."\n" + .'> URL中的 OSS bucket 需要先添加到IMS[存储管理](~~609918~~)后再使用。'."\n" + ."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'user-data', + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '调度参数', + 'description' => '调度参数。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 id。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'MediaInfoJob' => [ + 'title' => 'MediaInfoJobDTO', + 'description' => 'MediaInfoJobDTO', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '任务名字', + 'description' => '任务名字。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'TriggerSource' => [ + 'title' => '任务来源 - API, WorkFlow, Console', + 'description' => '任务来源 '."\n" + .'- API：API'."\n" + ."\n" + .'- WorkFlow：工作流'."\n" + ."\n" + .'- Console：控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'JobId' => [ + 'title' => '任务 id', + 'description' => '任务 id。', + 'type' => 'string', + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + 'Input' => [ + 'title' => '任务输入', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。取值： OSS: OSS文件, Media: 媒资 ID', + 'description' => '媒体对象类型。取值： '."\n" + ."\n" + .'- OSS：OSS文件'."\n" + ."\n" + .'- Media：媒资 ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' '."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'Async' => [ + 'title' => '是否异步处理', + 'description' => '是否异步处理。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '调度信息', + 'description' => '调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + .'- Init：已提交'."\n" + ."\n" + .'- Success：成功'."\n" + ."\n" + .'- Fail：失败', + 'type' => 'string', + 'example' => 'Init', + ], + 'SubmitResultJson' => [ + 'title' => '任务提交信息', + 'description' => '任务提交信息。', + 'type' => 'object', + 'example' => '{}', + ], + 'MediaInfoProperty' => [ + 'title' => '媒体信息详情', + 'description' => '媒体信息详情。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '2b36bd19c13f4145b094c0cad80dbce5', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件url。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'us', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0：没有 B 帧, '."\n" + .'- 1：有一个 B 帧, '."\n" + .'- 2：有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。取值 0, 90, 180, 270。默认值 0', + 'description' => '视频画面旋转角度。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitTime' => [ + 'title' => '任务提交时间', + 'description' => '任务提交时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务完成时间', + 'description' => '任务完成时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 id。', + 'type' => 'string', + 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"MediaInfoJob\\": {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82dfa8e8\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {},\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"2b36bd19c13f4145b094c0cad80dbce5\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"us\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n}","type":"json"}]', + 'title' => '提交媒体信息异步任务', + 'summary' => '提交媒体信息异步任务。', + 'description' => '您可以调用本接口，通过回调或者再次查询的方式，对输入的文件进行媒体分析，适用于时效性需求相对较弱，或并发量高的场景。', + ], + 'GetMediaInfoJob' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务 ID', + 'description' => '任务 id', + 'type' => 'string', + 'required' => false, + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 id', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'MediaInfoJob' => [ + 'title' => 'MediaInfoJobDTO', + 'description' => 'MediaInfoJobDTO', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '任务名字', + 'description' => '任务名字。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'TriggerSource' => [ + 'title' => '任务来源 - API, WorkFlow, Console', + 'description' => '任务来源。 '."\n" + ."\n" + .'- API：API'."\n" + ."\n" + .'- WorkFlow：工作流'."\n" + ."\n" + .'- Console：控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'JobId' => [ + 'title' => '任务 id', + 'description' => '任务 ID', + 'type' => 'string', + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + 'Input' => [ + 'title' => '任务输入', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + .' '."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' '."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'Async' => [ + 'title' => '是否异步处理', + 'description' => '是否异步处理。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '调度信息', + 'description' => '调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f9c56', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + .'- Init：已提交'."\n" + ."\n" + .'- Success：成功'."\n" + ."\n" + .'- Fail：失败', + 'type' => 'string', + 'example' => 'Init', + ], + 'SubmitResultJson' => [ + 'title' => '任务提交信息', + 'description' => '任务提交信息。', + 'type' => 'object', + ], + 'MediaInfoProperty' => [ + 'title' => '媒体信息详情', + 'description' => '媒体信息详情。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => 'e520090207114cc7a392d44f0b211574', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位： 秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'us', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0：没有 B 帧, '."\n" + .'- 1：有一个 B 帧, '."\n" + .'- 2：有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitTime' => [ + 'title' => '任务提交时间', + 'description' => '任务提交时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务完成时间', + 'description' => '任务完成时间。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"MediaInfoJob\\": {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82dfa8e8\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f9c56\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"e520090207114cc7a392d44f0b211574\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"us\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"zh\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n}","type":"json"}]', + 'title' => '媒体信息任务查询', + 'summary' => '查询媒体信息。', + ], + 'ListMediaInfoJobs' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-15T00:00:00Z', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '按 jobId 筛选。', + 'description' => '按 jobId 筛选。', + 'type' => 'string', + 'required' => false, + 'example' => '7b38a5d86f1e47838927b6e7ccb1****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + ."\n" + .'- Init: 已提交, '."\n" + .'- Success: 成功, '."\n" + .'- Fail: 失败', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', + 'description' => '排序顺序。目前只支持两种：'."\n" + .'- CreateTimeDesc：按创建时间降序'."\n" + .'- CreateTimeAsc：按创建时间升序', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。范围: 0~100，默认值：20。', + 'description' => '分页大小 default 10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记 (第一页没有)。', + 'description' => '连续分页查询时下一页的标记 （第一页没有）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'Jobs' => [ + 'description' => '媒体信息任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '任务名字。', + 'description' => '任务名字。', + 'type' => 'string', + 'example' => 'job-name', + ], + 'TriggerSource' => [ + 'title' => '任务来源。 API: API, WorkFlow: 工作流, Console: 控制台', + 'description' => '任务来源。'."\n" + .'- API：API'."\n" + .'- WorkFlow：工作流'."\n" + .'- Console：控制台', + 'type' => 'string', + 'example' => 'API', + ], + 'JobId' => [ + 'title' => '任务 ID。', + 'description' => '任务 ID。', + 'type' => 'string', + 'example' => 'ab4802364a2e49208c99efab82df****', + ], + 'Input' => [ + 'title' => '任务输入。', + 'description' => '任务输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '媒体值：'."\n" + .' type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .' type 为 Media 时，为媒资 ID。', + 'description' => '媒体值：'."\n" + ."\n" + .'- type 为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议；'."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'example' => 'oss://bucket/path/to/video.mp4', + ], + ], + ], + 'Async' => [ + 'title' => '是否异步处理。', + 'description' => '是否异步处理。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UserData' => [ + 'title' => '用户数据。', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'user-data', + ], + 'ScheduleConfig' => [ + 'title' => '调度信息。', + 'description' => '调度信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'title' => '管道 ID。', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => 'e37ebee5d98b4781897f6086e89f****', + ], + 'Priority' => [ + 'title' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'description' => '任务优先级。数字越大优先级越高，取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'Status' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + ."\n" + .'- Init: 已提交, '."\n" + .'- Success: 成功, '."\n" + .'- Fail: 失败', + 'type' => 'string', + 'example' => 'Init', + ], + 'SubmitResultJson' => [ + 'title' => '任务提交信息。', + 'description' => '任务提交信息。', + 'type' => 'object', + ], + 'MediaInfoProperty' => [ + 'title' => '媒体信息详情。', + 'description' => '媒体信息详情。', + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '基础文件信息', + 'description' => '基础文件信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资 ID。', + 'description' => '媒资 ID。', + 'type' => 'string', + 'example' => '4765337007f571edbfdf81848c01****', + ], + 'FileName' => [ + 'title' => '文件名。', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'file.m3u8', + ], + 'FileStatus' => [ + 'title' => '文件状态。', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型。取值: source_file, transcode_file', + 'description' => '文件类型。取值：'."\n" + ."\n" + .'- source_file：源文件'."\n" + .'- transcode_file：转码文件', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小。单位：Byte。', + 'description' => '文件大小。单位：Byte。', + 'type' => 'string', + 'example' => '31737', + ], + 'FileUrl' => [ + 'title' => '文件 URL。', + 'description' => '文件 URL。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8', + ], + 'Region' => [ + 'title' => '文件所在区域。', + 'description' => '文件所在区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '视频格式名称。', + 'description' => '视频格式名称。', + 'type' => 'string', + 'example' => 'hls,applehttp', + ], + 'Duration' => [ + 'title' => '视频时长（单位: 秒）。', + 'description' => '视频时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039999', + ], + 'Bitrate' => [ + 'title' => '视频码率。', + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息', + 'description' => '音频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '音频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码器时间基。', + 'description' => '编码器时间基。', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码器标签名。', + 'description' => '编码器标签名。', + 'type' => 'string', + 'example' => '[15][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码器标签。', + 'description' => '编码器标签。', + 'type' => 'string', + 'example' => '0x000f', + ], + 'SampleFmt' => [ + 'title' => '采样格式。', + 'description' => '采样格式。', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率（单位: Hz）。', + 'description' => '采样率（单位：Hz）。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数。', + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道布局。', + 'description' => '声道布局。', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时间基。', + 'description' => '时间基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'StartTime' => [ + 'title' => '开始时间。', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bitrate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '0.f', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息', + 'description' => '视频流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '视频流信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '流序号。', + 'description' => '流序号。', + 'type' => 'string', + 'example' => '0', + ], + 'Codec_name' => [ + 'title' => '编码格式。', + 'description' => '编码格式。', + 'type' => 'string', + 'example' => 'h264', + ], + 'Codec_long_name' => [ + 'title' => '编码格式名。', + 'description' => '编码格式名。', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码器预设。', + 'description' => '编码器预设。', + 'type' => 'string', + 'example' => 'High', + ], + 'Codec_time_base' => [ + 'description' => '编码时基。', + 'type' => 'string', + 'example' => '1/50', + ], + 'Codec_tag_string' => [ + 'title' => '编码格式标记文本。', + 'description' => '编码格式标记文本。', + 'type' => 'string', + 'example' => '[27][0][0][0]', + ], + 'Codec_tag' => [ + 'title' => '编码格式标记。', + 'description' => '编码格式标记。', + 'type' => 'string', + 'example' => '0x001b', + ], + 'Width' => [ + 'title' => '宽。', + 'description' => '宽。', + 'type' => 'string', + 'example' => '848', + ], + 'Height' => [ + 'title' => '高。', + 'description' => '高。', + 'type' => 'string', + 'example' => '478', + ], + 'Has_b_frames' => [ + 'title' => '是否有B帧。'."\n" + .'取值: '."\n" + .'- 0: 没有 B 帧, '."\n" + .'- 1: 有一个 B 帧, '."\n" + .'- 2: 有多个连续 B 帧。', + 'description' => '是否有B帧。'."\n" + .'取值：'."\n" + .'- 0：没有 B 帧, '."\n" + .'- 1：有一个 B 帧, '."\n" + .'- 2：有多个连续 B 帧。', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '采集点数宽高比。', + 'description' => '采集点数宽高比。', + 'type' => 'string', + 'example' => '478:477', + ], + 'Dar' => [ + 'title' => '图像显示宽高比。', + 'description' => '图像显示宽高比。', + 'type' => 'string', + 'example' => '16:9', + ], + 'PixFmt' => [ + 'title' => '颜色存储格式。', + 'description' => '颜色存储格式。', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级。', + 'description' => '编码等级。', + 'type' => 'string', + 'example' => '31', + ], + 'Fps' => [ + 'title' => '帧率。', + 'description' => '帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Avg_fps' => [ + 'title' => '平均帧率。', + 'description' => '平均帧率。', + 'type' => 'string', + 'example' => '25.0', + ], + 'Time_base' => [ + 'title' => '时基。', + 'description' => '时基。', + 'type' => 'string', + 'example' => '1/90000', + ], + 'Start_time' => [ + 'title' => '起始时间。', + 'description' => '起始时间。', + 'type' => 'string', + 'example' => '1.473556', + ], + 'Duration' => [ + 'title' => '时长（单位: 秒）。', + 'description' => '时长（单位：秒）。', + 'type' => 'string', + 'example' => '403.039989', + ], + 'Bit_rate' => [ + 'title' => '码率。', + 'description' => '码率。', + 'type' => 'string', + 'example' => '888.563', + ], + 'NumFrames' => [ + 'title' => '总帧数。', + 'description' => '总帧数。', + 'type' => 'string', + 'example' => '10040', + ], + 'Lang' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Rotate' => [ + 'title' => '视频画面旋转角度。'."\n" + .'取值 0, 90, 180, 270。'."\n" + .'默认值 0', + 'description' => '视频画面旋转角度。'."\n" + ."\n" + .'- 取值 0, 90, 180, 270。'."\n" + .'- 默认值 0', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'SubmitTime' => [ + 'title' => '任务提交时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务提交时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'FinishTime' => [ + 'title' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'description' => '任务完成时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-01-12T08:49:41Z', + ], + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168', + ], + ], + ], + ], + 'NextPageToken' => [ + 'title' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'description' => '下一页标识，第一次提交时为空即可。下一页标识将在第一次查询后返回。', + 'type' => 'string', + 'example' => '019daf5780f74831b0e1a767c9f1c178', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Jobs\\": [\\n {\\n \\"Name\\": \\"job-name\\",\\n \\"TriggerSource\\": \\"API\\",\\n \\"JobId\\": \\"ab4802364a2e49208c99efab82df****\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/path/to/video.mp4\\"\\n },\\n \\"Async\\": true,\\n \\"UserData\\": \\"user-data\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"e37ebee5d98b4781897f6086e89f****\\",\\n \\"Priority\\": 5\\n },\\n \\"Status\\": \\"Init\\",\\n \\"SubmitResultJson\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MediaInfoProperty\\": {\\n \\"FileBasicInfo\\": {\\n \\"MediaId\\": \\"4765337007f571edbfdf81848c01****\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"31737\\",\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Lang\\": \\"cn\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"Codec_time_base\\": \\"1/50\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Width\\": \\"848\\",\\n \\"Height\\": \\"478\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"31\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"NumFrames\\": \\"10040\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Rotate\\": \\"0\\"\\n }\\n ]\\n },\\n \\"SubmitTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"FinishTime\\": \\"2022-01-12T08:49:41Z\\",\\n \\"RequestId\\": \\"4879B9DE-E4B6-19DC-91F5-9D5F4DCE4168\\"\\n }\\n ],\\n \\"NextPageToken\\": \\"019daf5780f74831b0e1a767c9f1c178\\"\\n}","type":"json"}]', + 'title' => '查询媒体信息任务列表', + 'summary' => '查询媒体信息任务列表。', + ], + 'CreateLiveTranscodeTemplate' => [ + 'summary' => '调用本接口创建实时转码模板，便于提交实时转码任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模版类型。'."\n" + .'- normal - 普通'."\n" + .'- narrow-band - 窄高'."\n" + .'- audio-only - 纯音频'."\n" + .'- origin - 原画', + 'type' => 'string', + 'required' => true, + 'example' => 'normal', + 'enum' => [ + 'normal', + 'narrow-band', + 'audio-only', + 'origin', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'my template', + 'maxLength' => 20, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '模版配置。'."\n" + .'> 针对不同的模板类型（Type）的传参要求，参数填写规则如下：当Type的值为normal时，宽和高参数中至少需要填写一个，同时帧率和码率参数为必填项；对于其他类型的模板，需根据具体需求填写相应的参数。', + 'type' => 'object', + 'properties' => [ + 'VideoParams' => [ + 'description' => '视频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '编码类型。可选值：'."\n" + ."\n" + .'- H.264'."\n" + .'- H.265', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + 'enum' => [ + 'H.264', + 'H.265', + ], + ], + 'Height' => [ + 'description' => '转码视频高度。取值：'."\n" + ."\n" + .'- Height ≥ 128'."\n" + ."\n" + .'- max（Height,Width）≤ 2560'."\n" + ."\n" + .'- min（Height,Width）≤ 1440'."\n" + ."\n" + .'><notice>265窄带高清模板不得超过1280×720。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '720', + ], + 'Width' => [ + 'description' => '转码视频宽度。取值：'."\n" + ."\n" + .'- Width ≥ 128'."\n" + ."\n" + .'- max（Height,Width）≤ 2560'."\n" + ."\n" + .'- min（Height,Width）≤ 1440'."\n" + ."\n" + .'><notice>265窄带高清模板不得超过1280×720。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '1280', + ], + 'Fps' => [ + 'description' => '转码视频帧率。单位：FPS，取值：1~60。', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + 'Bitrate' => [ + 'description' => '转码视频比特率。单位：kbps，取值：1~6000。', + 'type' => 'string', + 'required' => false, + 'example' => '2500', + ], + 'Gop' => [ + 'description' => '视频GOP（Group of Picture）。单位：帧，取值：1~3000。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'Profile' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + ."\n" + .'- 1：baseline（适合移动设备）。'."\n" + ."\n" + .'- 2：main（适合标准分辨率设备）。'."\n" + ."\n" + .'- 3：high（适合高分辨率设备）。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'enum' => [ + '1', + '2', + '3', + ], + ], + ], + 'required' => false, + ], + 'AudioParams' => [ + 'description' => '音频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '音频编码格式。取值：'."\n" + ."\n" + .'- AAC'."\n" + .'- MP3', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC', + 'enum' => [ + 'AAC', + 'MP3', + ], + ], + 'Bitrate' => [ + 'description' => '转码音频比特率。单位：kbps，取值：1~1000。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + 'Samplerate' => [ + 'description' => '音频采样率。取值：22050~96000。'."\n" + ."\n" + .'><notice>如果AudioProfile取值为aac_ld，则采样率不能超过44100。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '44100', + ], + 'Channels' => [ + 'description' => '音频声道数。取值'."\n" + ."\n" + .'- 1：单声道。'."\n" + ."\n" + .'- 2：双声道。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'Profile' => [ + 'description' => '音频编码预置。当Codec为AAC时，取值：'."\n" + .'- aac_low'."\n" + .'- aac_he'."\n" + .'- aac_he\\_v2'."\n" + .'- aac_ld', + 'type' => 'string', + 'required' => false, + 'example' => 'aaclow', + 'enum' => [ + 'aac_low', + 'aac_he', + 'aac_he_v2', + 'aac_ld', + ], + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TemplateId' => [ + 'description' => '模版ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.Height', + 'errorMessage' => 'Invalid Parameters: Height', + ], + [ + 'errorCode' => 'InvalidParam.Width', + 'errorMessage' => 'Invalid Parameters: Width', + ], + [ + 'errorCode' => 'InvalidParam.Fps', + 'errorMessage' => 'Invalid Parameters: Fps', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '创建实时媒体转码模版', + 'description' => '仅上海区域支持实时媒体转码。', + ], + 'GetLiveTranscodeTemplate' => [ + 'summary' => '调用GetLiveTranscodeTemplate获取单个实时转码模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TemplateContent' => [ + 'description' => '模版内容。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'my-template', + ], + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => 'bcfa57950bc649b2abfb476ecd36ea4f', + ], + 'Type' => [ + 'description' => '模板类型。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Category' => [ + 'description' => '模版类别。'."\n" + .'- system: 系统'."\n" + .'- customized: 自定义', + 'type' => 'string', + 'example' => 'customized', + ], + 'CreateTime' => [ + 'description' => '模版创建时间。', + 'type' => 'string', + 'example' => '2022-07-25T06:15:14Z', + ], + 'TemplateConfig' => [ + 'description' => '模版配置信息。', + 'type' => 'object', + 'properties' => [ + 'VideoParams' => [ + 'description' => '视频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '编码类型。', + 'type' => 'string', + 'example' => 'H.264', + ], + 'Height' => [ + 'description' => '转码视频高度。', + 'type' => 'string', + 'example' => '720', + ], + 'Width' => [ + 'description' => '转码视频宽度。', + 'type' => 'string', + 'example' => '1280', + ], + 'Fps' => [ + 'description' => '转码视频帧率。', + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => '转码视频比特率。', + 'type' => 'string', + 'example' => '2500', + ], + 'Gop' => [ + 'description' => '视频GOP（Group of Picture）', + 'type' => 'string', + 'example' => '1000', + ], + 'Profile' => [ + 'description' => '编码级别。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + 'AudioParams' => [ + 'description' => '音频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '音频编码格式。', + 'type' => 'string', + 'example' => 'AAC', + ], + 'Bitrate' => [ + 'description' => '转码音频比特率。', + 'type' => 'string', + 'example' => '1000', + ], + 'Samplerate' => [ + 'description' => '音频采样率。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'Profile' => [ + 'description' => '音频编码预置。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TemplateContent\\": {\\n \\"Name\\": \\"my-template\\",\\n \\"TemplateId\\": \\"bcfa57950bc649b2abfb476ecd36ea4f\\",\\n \\"Type\\": \\"normal\\",\\n \\"Category\\": \\"customized\\",\\n \\"CreateTime\\": \\"2022-07-25T06:15:14Z\\",\\n \\"TemplateConfig\\": {\\n \\"VideoParams\\": {\\n \\"Codec\\": \\"H.264\\",\\n \\"Height\\": \\"720\\",\\n \\"Width\\": \\"1280\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"2500\\",\\n \\"Gop\\": \\"1000\\",\\n \\"Profile\\": \\"2\\"\\n },\\n \\"AudioParams\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"Profile\\": \\"1\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取单个实时媒体转码模版', + ], + 'UpdateLiveTranscodeTemplate' => [ + 'summary' => '更新实时转码模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。可以通过台[智能媒体服务控制台](https://ims.console.aliyun.com/summary)>模板管理>实时转码模板或[创建实时转码模板](~~449217~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1130-2', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '模版配置。', + 'type' => 'object', + 'properties' => [ + 'VideoParams' => [ + 'description' => '视频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '编码类型。可选值：'."\n" + ."\n" + .'- H.264'."\n" + .'- H.265', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'H.264' => 'H.264', + 'H.265' => 'H.265', + ], + 'example' => 'H.264', + 'enum' => [], + ], + 'Height' => [ + 'description' => '转码视频高度。取值：'."\n" + ."\n" + .'- Height ≥ 128'."\n" + .'- max（Height,Width）≤ 2560'."\n" + .'- min（Height,Width）≤ 1440'."\n" + ."\n" + .'> H.265窄带高清模板不得超过1280×720。', + 'type' => 'string', + 'required' => false, + 'example' => '720', + ], + 'Width' => [ + 'description' => '转码视频宽度。取值：'."\n" + .'- Width ≥ 128'."\n" + .'- max（Height,Width）≤ 2560'."\n" + .'- min（Height,Width）≤ 1440'."\n" + ."\n" + .'>H.265窄带高清模板不得超过1280×720。', + 'type' => 'string', + 'required' => false, + 'example' => '1280', + ], + 'Fps' => [ + 'description' => '转码视频帧率。单位：FPS，取值：1~60。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => '转码视频比特率。单位：kbps，取值：1~6000。', + 'type' => 'string', + 'required' => false, + 'example' => '2500', + ], + 'Gop' => [ + 'description' => '视频GOP（Group of Picture）。单位：帧，取值：1~3000。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'Profile' => [ + 'description' => '编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：'."\n" + .'- 1：baseline（适合移动设备）。'."\n" + .'- 2：main（适合标准分辨率设备）。'."\n" + .'- 3：high（适合高分辨率设备）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + '2', + '3', + ], + 'example' => '2', + ], + ], + 'required' => false, + ], + 'AudioParams' => [ + 'description' => '音频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '音频编码格式。取值：'."\n" + .'AAC'."\n" + .'MP3', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MP3' => 'MP3', + 'AAC' => 'AAC', + ], + 'example' => 'AAC', + 'enum' => [], + ], + 'Bitrate' => [ + 'description' => '转码音频比特率。单位：kbps，取值：1~1000。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + 'Samplerate' => [ + 'description' => '音频采样率。取值：22050~96000。'."\n" + ."\n" + .'注意如果AudioProfile取值为aac_ld，则采样率不能超过44100。', + 'type' => 'string', + 'required' => false, + 'example' => '44100', + ], + 'Channels' => [ + 'description' => '音频声道数。取值'."\n" + .'1：单声道。'."\n" + .'2：双声道。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + '2', + ], + 'example' => '2', + ], + 'Profile' => [ + 'description' => '音频编码预置。当Codec为AAC时，取值：'."\n" + ."\n" + .'- aac_low'."\n" + .'- aac_he'."\n" + .'- aac_he\\_v2'."\n" + .'- aac_ld', + 'type' => 'string', + 'required' => false, + 'example' => 'aac_low', + 'enum' => [], + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam.TemplateIdInuse', + 'errorMessage' => 'Parameters: templateId is inuse.', + ], + ], + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '更新实时媒体转码模版', + ], + 'DeleteLiveTranscodeTemplate' => [ + 'summary' => '删除实时转码模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模板ID。可以通过[智能媒体服务控制台](https://ice.console.aliyun.com/summary)>模板管理>实时转码模板或[创建实时转码模板](~~449217~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => '****d80e4e4044975745c14b****', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Parameters: templateId is inuse.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '删除实时媒体转码模版', + ], + 'ListLiveTranscodeTemplates' => [ + 'summary' => '调用ListLiveTranscodeTemplates获取实时媒体转码模版列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模版类型。'."\n" + ."\n" + .'- normal - 普通'."\n" + .'- narrow-band - 窄高'."\n" + .'- audio-only - 纯音频'."\n" + .'- origin - 原画', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'enum' => [ + 'normal', + 'narrow-band', + 'audio-only', + 'origin', + ], + ], + ], + [ + 'name' => 'VideoCodec', + 'in' => 'query', + 'schema' => [ + 'description' => '视频编码。可选值：'."\n" + ."\n" + .'- H.264'."\n" + .'- H.265', + 'type' => 'string', + 'required' => false, + 'example' => 'H.264', + 'enum' => [ + 'H.264', + 'H.265', + ], + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '20', + 'default' => '50', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序，按CreateTime排序，默认是desc。'."\n" + ."\n" + .'- asc - 正序'."\n" + .'- desc - 倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词。模板ID/名称，名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'my_template', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '模版类别。'."\n" + .'- system: 系统'."\n" + .'- customized: 自定义', + 'type' => 'string', + 'required' => false, + 'example' => 'customized', + 'enum' => [ + 'system', + 'customized', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TemplateContentList' => [ + 'description' => '转码模版列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '模版名称。', + 'type' => 'string', + 'example' => 'my_template', + ], + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '9b1571b513cb44f7a1ba6ae561ff46f7', + ], + 'Type' => [ + 'description' => '模板类型。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Category' => [ + 'description' => '模版类别。', + 'type' => 'string', + 'example' => 'system', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-07-20T03:26:36Z', + ], + 'TemplateConfig' => [ + 'description' => '模版配置。', + 'type' => 'object', + 'properties' => [ + 'VideoParams' => [ + 'description' => '视频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '编码格式', + 'type' => 'string', + 'example' => '264', + ], + 'Height' => [ + 'description' => '视频分辨率高。', + 'type' => 'string', + 'example' => '1280', + ], + 'Width' => [ + 'description' => '视频分辨率宽。', + 'type' => 'string', + 'example' => '720', + ], + 'Fps' => [ + 'description' => '视频帧率', + 'type' => 'string', + 'example' => '30', + ], + 'Bitrate' => [ + 'description' => '视频码率。', + 'type' => 'string', + 'example' => '2500', + ], + 'Gop' => [ + 'description' => '视频Gop，单位：帧', + 'type' => 'string', + 'example' => '1000', + ], + 'Profile' => [ + 'description' => '编码级别。', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'AudioParams' => [ + 'description' => '音频参数。', + 'type' => 'object', + 'properties' => [ + 'Codec' => [ + 'description' => '音频编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC', + ], + 'Bitrate' => [ + 'description' => '音频码率。', + 'type' => 'string', + 'example' => '1000', + ], + 'Samplerate' => [ + 'description' => '音频采样率。', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'description' => '声道数。', + 'type' => 'string', + 'example' => '2', + ], + 'Profile' => [ + 'description' => '编码级别。', + 'type' => 'string', + 'example' => 'aac_low', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TotalCount\\": 100,\\n \\"TemplateContentList\\": [\\n {\\n \\"Name\\": \\"my_template\\",\\n \\"TemplateId\\": \\"9b1571b513cb44f7a1ba6ae561ff46f7\\",\\n \\"Type\\": \\"normal\\",\\n \\"Category\\": \\"system\\",\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateConfig\\": {\\n \\"VideoParams\\": {\\n \\"Codec\\": \\"264\\",\\n \\"Height\\": \\"1280\\",\\n \\"Width\\": \\"720\\",\\n \\"Fps\\": \\"30\\",\\n \\"Bitrate\\": \\"2500\\",\\n \\"Gop\\": \\"1000\\",\\n \\"Profile\\": \\"3\\"\\n },\\n \\"AudioParams\\": {\\n \\"Codec\\": \\"AAC\\",\\n \\"Bitrate\\": \\"1000\\",\\n \\"Samplerate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"Profile\\": \\"aac_low\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取实时媒体转码模版列表', + ], + 'SubmitLiveTranscodeJob' => [ + 'summary' => '调用本接口提交实时转码任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'StartMode', + 'in' => 'query', + 'schema' => [ + 'description' => '启动模式。'."\n" + ."\n" + .'- 0 - 立即启动'."\n" + .'- 1 - 定时启动', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '流输入信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '流输入类型。目前只支持rtmp。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp', + 'enum' => [ + 'rtmp', + ], + ], + 'InputUrl' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TranscodeOutput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转码输出信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出流类型。'."\n" + .'LiveCenter：阿里云视频直播域名生成地址'."\n" + ."\n" + .'> 目前只支持LiveCenter。', + 'type' => 'string', + 'required' => true, + 'example' => 'LiveCenter', + ], + 'DomainName' => [ + 'description' => '视频直播播流域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'mydomain', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TimedConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '定时任务配置。'."\n" + .'当StartMode=1时该参数必填。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '转码任务启动时间。'."\n" + .'><notice>启动时间与当前时间的跨度不可超过7天。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-21T00:00:00Z', + ], + 'EndTime' => [ + 'description' => '转码任务停止时间。'."\n" + .'><notice>停止时间与当前时间的跨度不可超过7天。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-20T08:20:32Z', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'JobId' => [ + 'description' => '转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交实时媒体转码任务', + 'description' => '- 提交立即生效的转码任务时，请确保输入的原始流在可播流'."\n" + .'- 提交延时转码任务时，请确保在指定时间前原始流可播流', + ], + 'SendLiveTranscodeJobCommand' => [ + 'summary' => '发送实时转码任务指令。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + 'enum' => [], + ], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => [ + 'description' => '操作指令。当前仅支持stop。用于关闭转码任务。', + 'type' => 'string', + 'required' => true, + 'example' => 'stop', + 'enum' => [ + 'stop', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '发送实时转码任务指令', + ], + 'GetLiveTranscodeJob' => [ + 'summary' => '调用GetLiveTranscodeJob获取单个实时转码任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Job' => [ + 'description' => '转码任务信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '转码任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + 'JobId' => [ + 'description' => '转码任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'TemplateType' => [ + 'description' => '模板类型', + 'type' => 'string', + 'example' => 'normal', + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'b6491d5b3e514b7d895d14b5453ea119', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'basic', + ], + 'StartMode' => [ + 'description' => '启动模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- 0 - 未启动'."\n" + .'- 1 - 运行中'."\n" + .'- 2 - 已停止', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StreamInput' => [ + 'description' => '输入流信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '流输入类型。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'InputUrl' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + ], + 'OutputStream' => [ + 'description' => '输出流信息。', + 'type' => 'object', + 'properties' => [ + 'StreamInfos' => [ + 'description' => '输出流信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出流协议类型。'."\n" + .'目前只支持rtmp协议。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'OutputUrl' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/mytranscode1', + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-07-20T02:48:58Z', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Job\\": {\\n \\"Name\\": \\"task1\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"TemplateType\\": \\"normal\\",\\n \\"TemplateId\\": \\"b6491d5b3e514b7d895d14b5453ea119\\",\\n \\"TemplateName\\": \\"basic\\",\\n \\"StartMode\\": 0,\\n \\"Status\\": 1,\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"InputUrl\\": \\"rtmp://mydomain/app/stream1\\"\\n },\\n \\"OutputStream\\": {\\n \\"StreamInfos\\": [\\n {\\n \\"Type\\": \\"rtmp\\",\\n \\"OutputUrl\\": \\"rtmp://mydomain/app/mytranscode1\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n}","type":"json"}]', + 'title' => '获取单个实施媒体转码任务', + ], + 'UpdateLiveTranscodeJob' => [ + 'summary' => '调用UpdateLiveTranscodeJob更新实时转码任务信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mytest3', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '流输入信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '流输入类型。目前只支持rtmp。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp', + 'enum' => [ + 'rtmp', + ], + ], + 'InputUrl' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TranscodeOutput', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '转码输出信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出流类型。'."\n" + .'LiveCenter：阿里云视频直播域名生成地址'."\n" + ."\n" + .'> 目前只支持LiveCenter', + 'type' => 'string', + 'required' => true, + 'example' => 'LiveCenter', + ], + 'DomainName' => [ + 'description' => '视频直播播流域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'mydomain', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TimedConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '定时任务配置。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '转码任务启动时间。'."\n" + .'><notice>启动时间与当前时间的跨度不可超过7天。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '2022-06-19T02:16:41Z'."\n", + ], + 'EndTime' => [ + 'description' => '转码任务停止时间。'."\n" + .'><notice>停止时间与当前时间的跨度不可超过7天。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-05T06:08:31Z', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '更新实时媒体转码任务', + 'description' => '- 非定时启动的任务，只能修改Name，所有状态均可。'."\n" + .'- 定时启动的任务，Name、StreamInput、TranscodeOutput、TimedConfig都可以修改，但StreamInput、TranscodeOutput、TimedConfig仅允许未启动状态下的修改。', + ], + 'DeleteLiveTranscodeJob' => [ + 'summary' => '删除指定实时转码任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '转码任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '删除实时媒体转码任务', + ], + 'ListLiveTranscodeJobs' => [ + 'summary' => '调用ListLiveTranscodeJobs获取实时媒体转码任务列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '转码任务对应的模版类型。'."\n" + ."\n" + .'- normal - 普通'."\n" + .'- narrow-band - 窄高'."\n" + .'- audio-only - 纯音频'."\n" + .'- origin - 原画', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + 'enum' => [ + 'normal', + 'narrow-band', + 'audio-only', + 'origin', + ], + ], + ], + [ + 'name' => 'StartMode', + 'in' => 'query', + 'schema' => [ + 'description' => '启动模式。'."\n" + ."\n" + .'- 0 - 立即启动'."\n" + .'- 1 - 定时启动', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'- 0：未启动'."\n" + ."\n" + .'- 1：运行中'."\n" + ."\n" + .'- 2：已停止', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '0', + '1', + '2', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '20', + 'default' => '50', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序，按CreateTime排序，默认是desc。'."\n" + ."\n" + .'- asc：正序'."\n" + .'- desc：倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'default' => 'desc', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词。任务ID/名称，名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '24ecbb5c-4f98-4194-9400-f17102e27fc5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'JobList' => [ + 'description' => '转码任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '转码任务名称。', + 'type' => 'string', + 'example' => 'mytask', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'TemplateType' => [ + 'description' => '转码任务对应转码模版的类型。', + 'type' => 'string', + 'example' => 'normal', + ], + 'TemplateId' => [ + 'description' => '转码任务对应的模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'StartMode' => [ + 'description' => '启动模式。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StreamInput' => [ + 'description' => '输入流信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入流类型。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'InputUrl' => [ + 'description' => '输入流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/stream1', + ], + ], + ], + 'OutputStream' => [ + 'description' => '输出流信息。', + 'type' => 'object', + 'properties' => [ + 'StreamInfos' => [ + 'description' => '播放地址列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出流协议类型。'."\n" + .'目前只支持rtmp协议。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'OutputUrl' => [ + 'description' => '输出流地址。', + 'type' => 'string', + 'example' => 'rtmp://mydomain/app/mytranscode1', + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-07-20T02:48:58Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"TotalCount\\": 100,\\n \\"JobList\\": [\\n {\\n \\"Name\\": \\"mytask\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateType\\": \\"normal\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"StartMode\\": 0,\\n \\"Status\\": 1,\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"InputUrl\\": \\"rtmp://mydomain/app/stream1\\"\\n },\\n \\"OutputStream\\": {\\n \\"StreamInfos\\": [\\n {\\n \\"Type\\": \\"rtmp\\",\\n \\"OutputUrl\\": \\"rtmp://mydomain/app/mytranscode1\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取实时媒体转码任务列表', + ], + 'CreateLiveRecordTemplate' => [ + 'summary' => '调用CreateLiveRecordTemplate创建实时录制模板，便于提交实时录制任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RecordFormat', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '录制格式', + 'description' => '录制格式列表', + 'type' => 'array', + 'items' => [ + 'title' => '格式', + 'description' => '录制格式', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '格式', + 'description' => '格式。'."\n" + ."\n" + .'>如果选择m3u8格式，必须同时设置请求参数SliceOssObjectPrefix和SliceDuration。'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'm3u8', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'm3u8', + 'mp4', + 'flv', + ], + ], + 'SliceDuration' => [ + 'title' => '切片时长', + 'description' => '单个切片时长。单位：秒。'."\n" + .'>当Format（格式）设为m3u8时，本参数才有效。'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '30', + 'pattern' => '', + 'default' => '', + ], + 'OssObjectPrefix' => [ + 'title' => 'Oss对象名', + 'description' => 'OSS存储的录制文件名。'."\n" + ."\n" + .'- 文件名小于256字节，支持变量匹配，包含{JobId}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。'."\n" + ."\n" + .'- 参数值必须要有{StartTime}或{EscapedStartTime}和{EndTime}或{EscapedEndTime}。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', + 'pattern' => '', + 'default' => '', + ], + 'SliceOssObjectPrefix' => [ + 'title' => '切片Oss对象名', + 'description' => 'TS切片名称。'."\n" + ."\n" + .'>当Format（格式）设为m3u8时，本参数才需要配置。'."\n" + ."\n" + .'- 默认30秒一片，小于256字节，支持变量匹配，包含{JobId}、{UnixTimestamp}、{Sequence}。'."\n" + .'- 参数值必须包含{UnixTimestamp}和{Sequence}变量。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', + 'pattern' => '', + 'default' => '', + ], + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。不填则默认为6小时。'."\n" + ."\n" + .'> - 如果在一个录制周期内，直播流发生了断流，但是在3分钟内，该直播流又正常推流，那么仍会在同一个录制文件中继续录制。'."\n" + .'- 一条直播流必须断流超过3分钟，才会生成最后一个录制文件。如果您需要修改默认的3分钟断流时间，可以提交工单进行修改。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '3600', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'deprecated' => false, + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源名称', + 'description' => '模板名称。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '资源一级ID', + 'description' => '模板ID', + 'type' => 'string', + 'deprecated' => false, + 'example' => '****96e8864746a0b6f3****', + 'pattern' => '', + 'readOnly' => true, + 'default' => '', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\"\\n}","type":"json"}]', + 'title' => '创建实时录制模板', + 'description' => '实时录制需指定录制模板。录制模板可以设置录制文件的输出格式（m3u8、mp4、flv）、录制文件时长等信息。', + ], + 'GetLiveRecordTemplate' => [ + 'summary' => '调用GetLiveRecordTemplate获取实时录制模板明细或任务模板快照。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '录制任务ID。传入JobId获取该任务使用的模板快照。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RecordTemplate' => [ + 'title' => '录制模板', + 'description' => '录制模板。', + 'type' => 'object', + 'properties' => [ + 'RecordFormatList' => [ + 'title' => '录制格式', + 'description' => '录制格式列表。', + 'type' => 'array', + 'items' => [ + 'title' => '格式', + 'description' => '录制格式。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '格式', + 'description' => '格式。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'm3u8', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'm3u8', + 'mp4', + 'flv', + ], + ], + 'OssObjectPrefix' => [ + 'title' => 'Oss对象名', + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}', + 'pattern' => '', + 'default' => '', + ], + 'SliceOssObjectPrefix' => [ + 'title' => '切片Oss对象名', + 'description' => 'TS切片名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', + 'pattern' => '', + 'default' => '', + ], + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。不填则默认为6小时。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '7200', + ], + 'SliceDuration' => [ + 'description' => '单个切片时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-07-20T03:26:36Z', + ], + 'LastModified' => [ + 'title' => '创建时间', + 'description' => '最后修改时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-07-20T03:26:36Z', + ], + 'TemplateId' => [ + 'title' => '资源一级ID', + 'description' => '模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '资源名称', + 'description' => '模板名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test template', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '资源名称', + 'description' => '模板类型。', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'system' => '系统预设模板', + 'custom' => '用户自定义模板', + ], + 'example' => 'custom', + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C892855F-95DF-50D6-A28C-279ABDB76810', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordTemplate\\": {\\n \\"RecordFormatList\\": [\\n {\\n \\"Format\\": \\"m3u8\\",\\n \\"OssObjectPrefix\\": \\"record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}\\",\\n \\"SliceOssObjectPrefix\\": \\"record/{JobId}/{UnixTimestamp}_{Sequence}\\",\\n \\"CycleDuration\\": 7200,\\n \\"SliceDuration\\": 30\\n }\\n ],\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"LastModified\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"Name\\": \\"test template\\",\\n \\"Type\\": \\"custom\\"\\n },\\n \\"RequestId\\": \\"C892855F-95DF-50D6-A28C-279ABDB76810\\"\\n}","type":"json"}]', + 'title' => '获取实时录制模板明细', + ], + 'UpdateLiveRecordTemplate' => [ + 'summary' => '调用UpdateLiveRecordTemplate更新实时录制模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RecordFormat', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '录制格式', + 'description' => '录制格式列表', + 'type' => 'array', + 'items' => [ + 'title' => '格式', + 'description' => '录制格式', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '格式', + 'description' => '格式。'."\n" + .'>如果选择m3u8格式，必须同时设置请求参数SliceOssObjectPrefix和SliceDuration。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'm3u8', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'm3u8', + 'mp4', + 'flv', + ], + ], + 'SliceDuration' => [ + 'title' => '切片时长', + 'description' => '单个切片时长。单位：秒。'."\n" + ."\n" + .'>当Format（格式）设为m3u8时，本参数才有效。'."\n" + ."\n" + .'不填则默认为30秒。取值范围：5s~30s。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '30', + 'pattern' => '', + 'default' => '', + ], + 'OssObjectPrefix' => [ + 'title' => 'Oss对象名', + 'description' => 'OSS存储的录制文件名。'."\n" + ."\n" + .'- 文件名小于256字节，支持变量匹配，包含{JobId}、{Sequence}、{StartTime}、{EndTime}、{EscapedStartTime}、{EscapedEndTime}。'."\n" + ."\n" + .'- 参数值必须要有{StartTime}或{EscapedStartTime}和{EndTime}或{EscapedEndTime}。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', + 'pattern' => '', + 'default' => '', + ], + 'SliceOssObjectPrefix' => [ + 'title' => '切片Oss对象名', + 'description' => 'TS切片名称。'."\n" + ."\n" + .'>当Format（格式）设为m3u8时，本参数才需要配置。'."\n" + .'默认30秒一片，小于256字节，支持变量匹配，包含{JobId}、{UnixTimestamp}、{Sequence}。'."\n" + ."\n" + .'参数值必须包含{UnixTimestamp}和{Sequence}变量。', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}'."\n", + 'pattern' => '', + 'default' => '', + ], + 'CycleDuration' => [ + 'description' => '周期录制时长。单位：秒。不填则默认为6小时。'."\n" + ."\n" + .'> - 如果在一个录制周期内，直播流发生了断流，但是在3分钟内，该直播流又正常推流，那么仍会在同一个录制文件中继续录制。'."\n" + .'- 一条直播流必须断流超过3分钟，才会生成最后一个录制文件。如果您需要修改默认的3分钟断流时间，可以提交工单进行修改。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '3600', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'deprecated' => false, + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源名称', + 'description' => '模板名称。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'test template', + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '资源一级ID', + 'description' => '资源一级ID', + 'type' => 'string', + 'deprecated' => false, + 'example' => '0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3', + 'pattern' => '', + 'readOnly' => true, + 'default' => '', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3\\"\\n}","type":"json"}]', + 'title' => '更新实时录制模板', + 'description' => '仅能更新用户创建的模板，系统预置模板不能更新。', + ], + 'DeleteLiveRecordTemplate' => [ + 'summary' => '调用DeleteLiveRecordTemplate删除实时录制模板，不影响现有任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '需要删除的实时录制模板ID。可以通过[智能媒体服务控制台](https://ice.console.aliyun.com/live-processing/template/list/record)或[创建实时录制模板](~~448213~~)的返回参数中获取。', + 'type' => 'string', + 'properties' => [], + 'deprecated' => false, + 'required' => true, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b7****', + 'pattern' => '', + 'readOnly' => true, + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3E5330CF-B4C8-5BEF-AA6B-8E70BD20FAEE\\"\\n}","type":"json"}]', + 'title' => '删除实时录制模板', + ], + 'ListLiveRecordTemplates' => [ + 'summary' => '调用ListLiveRecordTemplates获取实时录制模板列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，可以根据模板ID和名称搜索。名称支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test template', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'system' => '系统预置', + 'custom' => '自定义', + ], + 'example' => 'custom', + ], + ], + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。最小值：1。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。1～100。默认值10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序排列', + 'desc' => '降序排列（默认值）', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RecordTemplateList' => [ + 'title' => '数组，返回示例目录。', + 'description' => '录制模板列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'LiveRecordTemplateItemType', + 'description' => '录制模板。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '资源名称', + 'description' => '模板名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test template', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '资源名称', + 'description' => '模板类型。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'custom', + 'pattern' => '', + 'default' => '', + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'deprecated' => false, + 'example' => '2022-07-20T03:26:36Z', + 'pattern' => '', + 'default' => '', + ], + 'TemplateId' => [ + 'title' => '资源一级ID', + 'description' => '模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + 'RecordFormatList' => [ + 'title' => '录制格式', + 'description' => '录制格式列表。', + 'type' => 'array', + 'items' => [ + 'title' => '格式', + 'description' => '录制格式。', + 'type' => 'object', + 'properties' => [ + 'Format' => [ + 'title' => '格式', + 'description' => '格式。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'm3u8', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'm3u8', + 'mp4', + 'flv', + ], + ], + 'SliceDuration' => [ + 'title' => '切片时长', + 'description' => '单个切片时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '30', + 'pattern' => '', + 'default' => '', + ], + 'OssObjectPrefix' => [ + 'title' => 'Oss对象名', + 'description' => 'OSS存储的录制文件名。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}', + 'pattern' => '', + 'default' => '', + ], + 'SliceOssObjectPrefix' => [ + 'title' => '切片Oss对象名', + 'description' => 'TS切片名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'record/{JobId}/{UnixTimestamp}_{Sequence}', + 'pattern' => '', + 'default' => '', + ], + 'CycleDuration' => [ + 'description' => '周期录制时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '21600', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-07-20T02:48:58Z', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'PageNo' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SortBy' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'enumValueTitles' => [ + 'asc' => '升序排列', + 'desc' => '降序排列（默认值）', + ], + 'example' => 'desc', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordTemplateList\\": [\\n {\\n \\"Name\\": \\"test template\\",\\n \\"Type\\": \\"custom\\",\\n \\"LastModified\\": \\"2022-07-20T03:26:36Z\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"RecordFormatList\\": [\\n {\\n \\"Format\\": \\"m3u8\\",\\n \\"SliceDuration\\": 30,\\n \\"OssObjectPrefix\\": \\"record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"SliceOssObjectPrefix\\": \\"record/{JobId}/{UnixTimestamp}_{Sequence}\\",\\n \\"CycleDuration\\": 21600\\n }\\n ],\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"TotalCount\\": 5,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', + 'title' => '获取实时录制模板列表', + ], + 'SubmitLiveRecordJob' => [ + 'summary' => '调用SubmitLiveRecordJob提交实时录制任务，对直播流进行录制。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NotifyUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '回调地址', + 'description' => '回调地址', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'https://example.com/imsnotify', + 'pattern' => '', + 'default' => '', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '直播流地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '直播流地址类型。目前支持rtmp。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rtmp' => 'rtmp', + ], + 'example' => 'rtmp', + ], + 'Url' => [ + 'description' => '直播流地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://example.com/live/stream1', + ], + ], + 'deprecated' => false, + 'required' => true, + ], + ], + [ + 'name' => 'RecordOutput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '录制存储地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '存储地址类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss', + ], + 'Bucket' => [ + 'description' => '存储空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'imsbucket1', + ], + 'Endpoint' => [ + 'description' => '存储服务地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + ], + 'deprecated' => false, + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '录制模板ID', + 'description' => '录制模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源名称', + 'description' => '录制任务名称。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'live stream record 1', + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', + ], + 'JobId' => [ + 'title' => '若创建接口为异步实现，则需返回明确的JobId。', + 'description' => '录制任务ID。', + 'type' => 'string', + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\"\\n}","type":"json"}]', + 'title' => '提交实时录制任务', + 'description' => '该接口目前支持阿里云直播或第三方RTMP直播流录制。建议先推流再调用本接口提交录制任务。如果直播流地址拉不到流，任务会尝试拉流3分钟。超时后录制服务将停止录制。'."\n" + ."\n" + .'提交录制任务前，需准备好阿里云OSS或VOD存储空间。建议使用在智能媒体服务中配置的存储地址，便于对录制生成的文件进行管理和处理。'."\n" + ."\n" + .'如果系统预置的录制模板不符合需求，可自行创建定制录制模板。', + ], + 'GetLiveRecordJob' => [ + 'summary' => '调用GetLiveRecordJob获取单个实时录制任务明细。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '录制任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RecordJob' => [ + 'title' => '录制任务', + 'description' => '录制任务。', + 'type' => 'object', + 'properties' => [ + 'NotifyUrl' => [ + 'title' => '回调地址', + 'description' => '回调地址。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'https://example.com/imsnotify', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-07-20T02:48:58Z', + ], + 'StreamInput' => [ + 'description' => '直播流地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '直播流类型，目前支持rtmp。', + 'type' => 'string', + 'enumValueTitles' => [ + 'rtmp' => 'rtmp', + ], + 'example' => 'rtmp', + ], + 'Url' => [ + 'description' => '直播流地址。', + 'type' => 'string', + 'example' => 'rtmp://example.com/app/stream', + ], + ], + 'deprecated' => false, + ], + 'RecordOutput' => [ + 'description' => '录制存储地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '存储地址类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'vod' => 'vod', + 'oss' => 'oss', + ], + 'example' => 'oss', + ], + 'Bucket' => [ + 'description' => '存储空间名称。', + 'type' => 'string', + 'example' => 'imsbucket1', + ], + 'Endpoint' => [ + 'description' => '存储服务地址。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + ], + 'deprecated' => false, + ], + 'TemplateId' => [ + 'title' => '录制模板ID', + 'description' => '录制模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + 'TemplateName' => [ + 'title' => '录制模板ID', + 'description' => '录制模板名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test template', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '资源名称', + 'description' => '录制任务名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '直播活动录制任务1', + 'pattern' => '', + 'default' => '', + ], + 'JobId' => [ + 'title' => '资源名称', + 'description' => '录制任务ID。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '资源名称', + 'description' => '录制任务状态。', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'paused' => '暂停', + 'initial' => '初始状态', + 'started' => '进行中', + ], + 'example' => 'paused', + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B57A046C-CE33-5FBB-B57A-D2B89ACF6907', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RecordJob\\": {\\n \\"NotifyUrl\\": \\"https://example.com/imsnotify\\",\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\",\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"Url\\": \\"rtmp://example.com/app/stream\\"\\n },\\n \\"RecordOutput\\": {\\n \\"Type\\": \\"oss\\",\\n \\"Bucket\\": \\"imsbucket1\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\"\\n },\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"TemplateName\\": \\"test template\\",\\n \\"Name\\": \\"直播活动录制任务1\\",\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\",\\n \\"Status\\": \\"paused\\"\\n },\\n \\"RequestId\\": \\"B57A046C-CE33-5FBB-B57A-D2B89ACF6907\\"\\n}","type":"json"}]', + 'title' => '获取实时录制任务明细', + ], + 'DeleteLiveRecordFiles' => [ + 'summary' => '调用DeleteLiveRecordFiles删除实时录制文件，可选择只删除记录或同时删除原始OSS文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RecordIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'UUID格式的文件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '13cbb83e-043c-4728-ac35-****', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RemoveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除OSS中的文件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '13cbb83e-043c-4728-ac35-*****', + ], + 'DeleteFileInfoList' => [ + 'description' => '删除失败的文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的文件。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '标识删除结果的Code。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '描述删除结果。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RecordId' => [ + 'description' => '被删除的录制的文件的ID。', + 'type' => 'string', + 'example' => '13cbb83e-043c-4728-ac35-*****', + ], + ], + ], + ], + 'Message' => [ + 'description' => '全局返回状态描述。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\",\\n \\"DeleteFileInfoList\\": [\\n {\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RecordId\\": \\"13cbb83e-043c-4728-ac35-*****\\"\\n }\\n ],\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '删除实时录制文件', + ], + 'ListLiveRecordJobs' => [ + 'summary' => '调用ListLiveRecordJobs获取实时录制任务列表，可分页获取。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，可以根据任务ID和名称搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。格式为yyyy-mm-ddthh:mm:ssz（UTC时间）。', + 'type' => 'string', + 'format' => 'iso8601', + 'required' => false, + 'example' => '2022-07-15T08:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，与StartTime相差不超过30天。格式为yyyy-mm-ddthh:mm:ssz（UTC时间）。', + 'type' => 'string', + 'format' => 'iso8601', + 'required' => false, + 'example' => '2022-07-11T08:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。默认不过滤状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'paused' => '暂停', + 'initial' => '初始', + 'started' => '运行中', + ], + 'example' => 'started', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序排列', + 'desc' => '降序排列', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A27DFFA4-F272-5563-8363-CB0BC42740BA', + ], + 'LiveRecordJobs' => [ + 'title' => '数组，返回示例目录。', + 'description' => '实时录制任务列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'LiveRecordJobItemType', + 'description' => 'LiveRecordJobItemType', + 'type' => 'object', + 'properties' => [ + 'RecordOutput' => [ + 'description' => '录制存储地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '存储地址类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'vod' => 'vod', + 'oss' => 'oss', + ], + 'example' => 'oss', + ], + 'Bucket' => [ + 'description' => '存储空间名称。', + 'type' => 'string', + 'example' => 'imsbucket1', + ], + 'Endpoint' => [ + 'description' => '存储服务地址。', + 'type' => 'string', + 'example' => 'oss-cn-hangzhou.aliyuncs.com', + ], + ], + 'deprecated' => false, + ], + 'Name' => [ + 'title' => '资源名称', + 'description' => '录制任务名称。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '直播活动录制任务1', + 'pattern' => '', + 'default' => '', + ], + 'NotifyUrl' => [ + 'title' => '回调地址', + 'description' => '回调地址。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'https://example.com/imsnotify', + 'pattern' => '', + 'default' => '', + ], + 'TemplateId' => [ + 'title' => '录制模板ID', + 'description' => '录制模板ID。', + 'type' => 'string', + 'deprecated' => false, + 'example' => '69e1f9fe-1e97-11ed-ba64-0c42a1b73d66', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2022-07-20T03:26:36Z', + ], + 'StreamInput' => [ + 'description' => '直播流地址。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '直播流地址类型。', + 'type' => 'string', + 'example' => 'rtmp', + ], + 'Url' => [ + 'description' => '直播流地址。', + 'type' => 'string', + 'example' => 'rtmp://example-live.com/live/stream1', + ], + ], + 'deprecated' => false, + ], + 'JobId' => [ + 'description' => '录制任务ID。', + 'type' => 'string', + 'example' => 'ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66', + ], + 'Status' => [ + 'description' => '录制任务状态。', + 'type' => 'string', + 'example' => 'paused', + ], + 'TemplateName' => [ + 'description' => '录制模板名称。', + 'type' => 'string', + 'example' => 'test template', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '180', + ], + 'PageNo' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。默认值10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SortBy' => [ + 'description' => '排序参数，默认根据创建时间倒序。', + 'type' => 'string', + 'example' => 'desc', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A27DFFA4-F272-5563-8363-CB0BC42740BA\\",\\n \\"LiveRecordJobs\\": [\\n {\\n \\"RecordOutput\\": {\\n \\"Type\\": \\"oss\\",\\n \\"Bucket\\": \\"imsbucket1\\",\\n \\"Endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"Name\\": \\"直播活动录制任务1\\",\\n \\"NotifyUrl\\": \\"https://example.com/imsnotify\\",\\n \\"TemplateId\\": \\"69e1f9fe-1e97-11ed-ba64-0c42a1b73d66\\",\\n \\"CreateTime\\": \\"2022-07-20T03:26:36Z\\",\\n \\"StreamInput\\": {\\n \\"Type\\": \\"rtmp\\",\\n \\"Url\\": \\"rtmp://example-live.com/live/stream1\\"\\n },\\n \\"JobId\\": \\"ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66\\",\\n \\"Status\\": \\"paused\\",\\n \\"TemplateName\\": \\"test template\\"\\n }\\n ],\\n \\"TotalCount\\": 180,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', + 'title' => '获取实时录制任务列表', + ], + 'ListLiveRecordFiles' => [ + 'summary' => '调用ListLiveRecordFiles查询某个时间段内的所有录制索引文件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。与StartTime间隔时间不能超过4天。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-22T08:00:00Z', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:01Z', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录制任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '9E83D5D0-8D72-5E7D-B61A-****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。取值范围：5~30，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序。取值：'."\n" + ."\n" + .'asc（默认值）：升序。'."\n" + ."\n" + .'desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'RecordFormat', + 'in' => 'query', + 'schema' => [ + 'description' => '录制文件格式。取值：'."\n" + ."\n" + .'m3u8， flv， mp4', + 'type' => 'string', + 'required' => false, + 'example' => 'm3u8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE24625C-7C0F-4020-8448-****', + ], + 'PageNo' => [ + 'description' => '分页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SortBy' => [ + 'description' => '排序。', + 'type' => 'string', + 'example' => 'asc', + ], + 'PageSize' => [ + 'description' => '每页大小。', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '符合条件的总个数。', + 'type' => 'string', + 'example' => '100', + ], + 'Files' => [ + 'description' => '索引文件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecordUrl' => [ + 'description' => '索引文件地址。', + 'type' => 'string', + 'example' => 'http://****/atestObject****.m3u8', + ], + 'StartTime' => [ + 'description' => '开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T07:36:00Z', + ], + 'EndTime' => [ + 'description' => '结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2015-12-01T07:36:10Z', + ], + 'Duration' => [ + 'description' => '录制时长。单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100.0', + ], + 'Width' => [ + 'description' => '视频宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '480', + ], + 'Height' => [ + 'description' => '视频高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '640', + ], + 'CreateTime' => [ + 'description' => 'UTC格式创建时间。', + 'type' => 'string', + 'example' => '2016-05-27T09:40:56Z', + ], + 'RecordOutput' => [ + 'description' => '录制文件的储存相关信息。', + 'type' => 'string', + 'example' => '{ "Type": "oss", "Endpoint":"oss-cn-shanghai.aliyuncs.com", "Bucket": "test-bucket" }', + ], + 'RecordId' => [ + 'description' => '索引文件ID。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + 'StreamUrl' => [ + 'description' => '直播流名。', + 'type' => 'string', + 'example' => 'LiveStream***', + ], + 'JobName' => [ + 'description' => '录制任务名称。', + 'type' => 'string', + 'example' => 'LiveRecordJob***', + ], + 'Format' => [ + 'description' => '录制文件格式。', + 'type' => 'string', + 'example' => 'm3u8', + ], + 'JobId' => [ + 'description' => '录制任务ID。', + 'type' => 'string', + 'example' => 'c4d7f0a4-b506-43f9-8de3-07732c3f****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE24625C-7C0F-4020-8448-****\\",\\n \\"PageNo\\": 1,\\n \\"SortBy\\": \\"asc\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Files\\": [\\n {\\n \\"RecordUrl\\": \\"http://****/atestObject****.m3u8\\",\\n \\"StartTime\\": \\"2015-12-01T07:36:00Z\\",\\n \\"EndTime\\": \\"2015-12-01T07:36:10Z\\",\\n \\"Duration\\": 100,\\n \\"Width\\": 480,\\n \\"Height\\": 640,\\n \\"CreateTime\\": \\"2016-05-27T09:40:56Z\\",\\n \\"RecordOutput\\": \\"{ \\\\\\"Type\\\\\\": \\\\\\"oss\\\\\\", \\\\\\"Endpoint\\\\\\":\\\\\\"oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Bucket\\\\\\": \\\\\\"test-bucket\\\\\\" }\\",\\n \\"RecordId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\",\\n \\"StreamUrl\\": \\"LiveStream***\\",\\n \\"JobName\\": \\"LiveRecordJob***\\",\\n \\"Format\\": \\"m3u8\\",\\n \\"JobId\\": \\"c4d7f0a4-b506-43f9-8de3-07732c3f****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询所有录制索引文件', + ], + 'CreateLiveSnapshotTemplate' => [ + 'summary' => '调用CreateLiveSnapshotTemplate创建实时截图模板，模板便于创建截图任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称。'."\n", + 'description' => '模板名称。'."\n" + .'- 最大长度为128。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '模板1', + ], + ], + [ + 'name' => 'OverwriteFormat', + 'in' => 'formData', + 'schema' => [ + 'title' => '覆盖截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" + .'支持占位符：'."\n" + .'{JobId}：截图任务ID'."\n" + .'不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符'."\n" + .'覆盖截图和序列截图的文件格式至少要设置一个。', + 'description' => '覆盖截图文件格式。'."\n" + ."\n" + .'- 不能以“/”开头，目前只支持.jpg后缀。'."\n" + .'- 最大长度为255。'."\n" + .'- 支持占位符： {JobId}：截图任务ID'."\n" + .'- 不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符。'."\n" + .'- 覆盖截图和序列截图的文件格式至少要设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{JobId}.jpg', + ], + ], + [ + 'name' => 'SequenceFormat', + 'in' => 'formData', + 'schema' => [ + 'title' => '序列截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" + .'支持占位符：'."\n" + .'{JobId}：截图任务ID'."\n" + .'{Date}：截图日期'."\n" + .'{UnixTimestamp}：时间戳'."\n" + .'{Sequence}：序列号'."\n" + .'其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" + .'覆盖截图和序列截图的文件格式至少要设置一个。', + 'description' => '序列截图文件格式。'."\n" + .'- 不能以“/”开头，目前只支持.jpg后缀。'."\n" + .'- 最大长度为255。'."\n" + .'- 支持占位符：{JobId}：截图任务ID、{Date}：截图日期、{UnixTimestamp}：时间戳、{Sequence}：序列号，其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" + .'- 覆盖截图和序列截图的文件格式至少要设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', + ], + ], + [ + 'name' => 'TimeInterval', + 'in' => 'formData', + 'schema' => [ + 'title' => '截图时间间隔，取值范围是[5, 3600]。', + 'description' => '截图时间间隔，单位：秒。'."\n" + .'- 取值范围是[5, 3600]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TemplateId' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\"\\n}","type":"json"}]', + 'title' => '创建实时截图模板', + ], + 'GetLiveSnapshotTemplate' => [ + 'summary' => '调用GetLiveSnapshotTemplate获取单个实时截图模板。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TemplateId' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'TemplateName' => [ + 'title' => '模板名称。', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'Type' => [ + 'title' => '模板类型。'."\n" + .'custom：自定义'."\n" + .'system：系统预置', + 'description' => '模板类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'system' => '系统预置', + 'custom' => '自定义', + ], + 'example' => 'custom', + ], + 'OverwriteFormat' => [ + 'title' => '覆盖截图文件格式。', + 'description' => '覆盖截图文件格式。', + 'type' => 'string', + 'example' => 'snapshot/{JobId}.jpg', + ], + 'SequenceFormat' => [ + 'title' => '序列截图文件格式。', + 'description' => '序列截图文件格式。', + 'type' => 'string', + 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', + ], + 'TimeInterval' => [ + 'title' => '截图时间间隔。', + 'description' => '截图时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LastModified' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + 'CreateTime' => [ + 'title' => '修改时间。', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => 'No such template.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"Type\\": \\"custom\\",\\n \\"OverwriteFormat\\": \\"snapshot/{JobId}.jpg\\",\\n \\"SequenceFormat\\": \\"snapshot/{JobId}/{UnixTimestamp}.jpg\\",\\n \\"TimeInterval\\": 5,\\n \\"LastModified\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', + 'title' => '获取实时截图模板', + ], + 'UpdateLiveSnapshotTemplate' => [ + 'summary' => '更新实时截图模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称。', + 'description' => '模板名称。'."\n" + .'- 最大长度为128。', + 'type' => 'string', + 'required' => true, + 'example' => '模板1', + ], + ], + [ + 'name' => 'OverwriteFormat', + 'in' => 'formData', + 'schema' => [ + 'title' => '覆盖截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" + .'支持占位符：'."\n" + .'{JobId}：截图任务ID'."\n" + .'不允许填写{UnixTimestamp}、{Sequence}等占位符'."\n" + .'覆盖截图和序列截图的文件格式至少要设置一个。', + 'description' => '覆盖截图文件格式。'."\n" + ."\n" + .'- 不能以“/”开头，目前只支持.jpg后缀。'."\n" + .'- 最大长度为255。'."\n" + .'- 支持占位符： {JobId}：截图任务ID'."\n" + .'- 不允许填写{UnixTimestamp}、{Sequence}、{Date}等占位符。'."\n" + .'- 覆盖截图和序列截图的文件格式至少要设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{JobId}.jpg', + ], + ], + [ + 'name' => 'SequenceFormat', + 'in' => 'formData', + 'schema' => [ + 'title' => '序列截图文件格式，不能以“/”开头，目前只支持.jpg后缀，最大长度为255。'."\n" + .'支持占位符：'."\n" + .'{JobId}：截图任务ID'."\n" + .'{Date}：截图日期'."\n" + .'{UnixTimestamp}：时间戳'."\n" + .'{Sequence}：序列号'."\n" + .'其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" + .'覆盖截图和序列截图的文件格式至少要设置一个。', + 'description' => '序列截图文件格式。'."\n" + .'- 不能以“/”开头，目前只支持.jpg后缀。'."\n" + .'- 最大长度为255。'."\n" + .'- 支持占位符：{JobId}：截图任务ID、{Date}：截图日期、{UnixTimestamp}：时间戳、{Sequence}：序列号，其中{UnixTimestamp}、{Sequence}至少要填写一个。'."\n" + .'- 覆盖截图和序列截图的文件格式至少要设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', + ], + ], + [ + 'name' => 'TimeInterval', + 'in' => 'formData', + 'schema' => [ + 'title' => '截图时间间隔，[5, 3600]。', + 'description' => '截图时间间隔，单位：秒。'."\n" + .'- 取值范围是[5, 3600]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => 'No such template.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '更新实时截图模板', + ], + 'DeleteLiveSnapshotTemplate' => [ + 'summary' => '删除实时截图模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => 'No such template.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除实时截图模板', + ], + 'ListLiveSnapshotTemplates' => [ + 'summary' => '调用ListLiveSnapshotTemplates获取实时截图模板列表，可分页获取。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchKeyWord', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键词，模板ID/名称，名称支持模糊搜索。', + 'description' => '搜索关键词，模板ID/名称，名称支持模糊搜索。'."\n" + .'- 最大长度为128。', + 'type' => 'string', + 'required' => false, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '指定模板ID查询，如果指定SearchKeyWord，该条件不生效。', + 'description' => '指定模板ID查询。'."\n" + .'- 如果指定SearchKeyWord，该条件不生效。'."\n" + .'- 数组长度最大为200。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型，默认是查询全部。'."\n" + .'custom：自定义'."\n" + .'system：系统预置', + 'description' => '模板类型，默认是查询全部。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'system' => '系统预置', + 'custom' => '自定义', + ], + 'example' => 'custom', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，[1, n)，默认是1。', + 'description' => '页码，[1, n)，默认是1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页宽，[1, 100]，默认是10。', + 'description' => '页宽，[1, 100]，默认是10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序，默认按CreateTime排序，默认是desc。'."\n" + .'asc：升序'."\n" + .'desc：倒序', + 'description' => '排序，默认按CreateTime排序，默认是desc。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '按CreateTime升序', + 'desc' => '按CreateTime倒序', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TemplateList' => [ + 'title' => '模板列表。', + 'description' => '模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'TemplateName' => [ + 'title' => '模板名称。', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'Type' => [ + 'title' => '模板类型。'."\n" + .'custom：自定义'."\n" + .'system：系统预置', + 'description' => '模板类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'system' => '系统预置', + 'custom' => '自定义', + ], + 'example' => 'custom', + ], + 'TimeInterval' => [ + 'title' => '截图时间间隔。', + 'description' => '截图时间间隔，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CreateTime' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-07-20T02:48:58Z', + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页宽。', + 'description' => '页宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SortBy' => [ + 'title' => '排序。', + 'description' => '排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'TotalCount' => [ + 'title' => '总数。', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TemplateList\\": [\\n {\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"Type\\": \\"custom\\",\\n \\"TimeInterval\\": 10,\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '获取实时截图模板列表', + ], + 'SubmitLiveSnapshotJob' => [ + 'summary' => '调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交，则会自动异步启动任务，否则为未启动状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobName', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务名称。', + 'description' => '任务名称。'."\n" + .'- 最大长度为128。', + 'type' => 'string', + 'required' => true, + 'example' => '截图任务1', + ], + ], + [ + 'name' => 'StreamInput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '流输入信息。', + 'description' => '流输入信息。', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '流输入地址。', + 'description' => '流输入地址。'."\n" + .'- 最大长度为255。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://www.aliyun.com/stream', + ], + 'Type' => [ + 'title' => '流输入类型。', + 'description' => '流输入类型。目前只支持rtmp。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rtmp' => 'rtmp', + ], + 'example' => 'rtmp', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'SnapshotOutput', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '截图输出信息。', + 'description' => '截图输出信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '截图存储类型。', + 'description' => '截图存储类型。目前只支持oss。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'oss' => 'oss', + ], + 'example' => 'oss', + ], + 'Endpoint' => [ + 'title' => '截图输出终端。', + 'description' => '截图输出终端。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + 'Bucket' => [ + 'title' => '截图输出终端的Bucket。', + 'description' => '截图输出终端的Bucket。', + 'type' => 'string', + 'required' => true, + 'example' => 'testbucket', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '截图回调地址。', + 'description' => '截图回调地址。'."\n" + .'- 最大长度为255。'."\n" + .'- 支持http/https', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/snapshot/callback', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable. ', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => 'No such template. ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287666****\\"\\n}","type":"json"}]', + 'title' => '提交实时截图任务', + ], + 'SendLiveSnapshotJobCommand' => [ + 'summary' => '发送实时截图任务指令。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'title' => '截图任务ID。', + 'description' => '截图任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'Command', + 'in' => 'formData', + 'schema' => [ + 'title' => '操作指令：start，stop，restart。', + 'description' => '操作指令：start，stop，restart。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'stop' => '停止任务', + 'restart' => '重启任务', + 'start' => '启动任务', + ], + 'example' => 'start', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'JobLimitExceeded', + 'errorMessage' => 'Job limit exceeded.', + ], + [ + 'errorCode' => 'StreamNotFound', + 'errorMessage' => 'No such stream.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'No such job.', + ], + ], + 409 => [ + [ + 'errorCode' => 'JobAlreadyStarted', + 'errorMessage' => 'Job is already started.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '发送实时截图任务指令', + ], + 'GetLiveSnapshotJob' => [ + 'summary' => '调用GetLiveSnapshotJob获取单个实时截图任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'JobName' => [ + 'title' => '任务名称。', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '截图任务1', + ], + 'TemplateId' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + 'TemplateName' => [ + 'title' => '模板名称。', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'Status' => [ + 'title' => '任务状态。'."\n" + .'init：未启动'."\n" + .'started：执行中'."\n" + .'paused：已停止', + 'description' => '任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '未启动', + 'paused' => '已停止', + 'started' => '执行中', + ], + 'example' => 'started', + ], + 'StreamInput' => [ + 'title' => '输入信息。', + 'description' => '输入信息。', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '输入地址。', + 'description' => '输入地址。', + 'type' => 'string', + 'example' => 'rtmp://www.aliyun.com/stream', + ], + 'Type' => [ + 'title' => '输入类型，rtmp、hls、flv。', + 'description' => '输入类型，目前只支持rtmp。', + 'type' => 'string', + 'enumValueTitles' => [ + 'rtmp' => 'rtmp', + ], + 'example' => 'rtmp', + ], + ], + ], + 'SnapshotOutput' => [ + 'title' => '输出信息。', + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类型，目前只支持oss。', + 'description' => '存储类型，目前只支持oss。', + 'type' => 'string', + 'enumValueTitles' => [ + 'oss' => 'oss', + ], + 'example' => 'oss', + ], + 'Endpoint' => [ + 'title' => '输出终端，type=oss时返回OSS域名。', + 'description' => '输出终端，type=oss时返回OSS域名。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + 'Bucket' => [ + 'title' => '输出终端的Bucket，type=oss时返回OSS Bucket。', + 'description' => '输出终端的Bucket，type=oss时返回OSS Bucket。', + 'type' => 'string', + 'example' => 'testbucket', + ], + ], + ], + 'OverwriteFormat' => [ + 'title' => '覆盖截图格式。', + 'description' => '覆盖截图格式。', + 'type' => 'string', + 'example' => 'snapshot/{JobId}.jpg', + ], + 'SequenceFormat' => [ + 'title' => '序列截图格式。', + 'description' => '序列截图格式。', + 'type' => 'string', + 'example' => 'snapshot/{JobId}/{UnixTimestamp}.jpg', + ], + 'TimeInterval' => [ + 'title' => '截图时间间隔。', + 'description' => '截图时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CallbackUrl' => [ + 'title' => '截图回调地址。', + 'description' => '截图回调地址。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/snapshot/callback', + ], + 'LastModified' => [ + 'title' => '最后修改时间。', + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + 'CreateTime' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'No such job.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"截图任务1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"Status\\": \\"started\\",\\n \\"StreamInput\\": {\\n \\"Url\\": \\"rtmp://www.aliyun.com/stream\\",\\n \\"Type\\": \\"rtmp\\"\\n },\\n \\"SnapshotOutput\\": {\\n \\"StorageType\\": \\"oss\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Bucket\\": \\"testbucket\\"\\n },\\n \\"OverwriteFormat\\": \\"snapshot/{JobId}.jpg\\",\\n \\"SequenceFormat\\": \\"snapshot/{JobId}/{UnixTimestamp}.jpg\\",\\n \\"TimeInterval\\": 5,\\n \\"CallbackUrl\\": \\"http://www.aliyun.com/snapshot/callback\\",\\n \\"LastModified\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', + 'title' => '获取实时截图任务', + ], + 'DeleteLiveSnapshotFiles' => [ + 'summary' => '调用DeleteLiveSnapshotFiles删除实时截图文件，可选择只删除记录或同时删除原始OSS文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceP3TB74', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '截图任务ID。', + 'description' => '截图任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'CreateTimestampList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '创建时间戳列表。', + 'description' => '创建时间戳列表。单次最多删除200个。', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1660638613798', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'DeleteOriginalFile', + 'in' => 'query', + 'schema' => [ + 'title' => '是否删除原始文件，默认是false。', + 'description' => '是否删除原始文件，默认是false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + ], + 'DeleteFileResultList' => [ + 'title' => '删除结果列表。', + 'description' => '删除结果列表。', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'title' => 'OK表示删除成功，其他表示删除失败。', + 'description' => 'OK表示删除成功，其他表示删除失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'OK' => '成功', + 'NotFound' => '图片不存在', + ], + 'example' => 'OK', + ], + 'CreateTimestamp' => [ + 'title' => '创建时间戳。', + 'description' => '创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660638613798', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'OverlayNotSupported', + 'errorMessage' => 'Not Sopport to remove overlay snapshot, please remove overlay snapshot from OSS console.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'BucketNotAuthorized', + 'errorMessage' => 'Bucket is not authorised.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'No such job.', + ], + [ + 'errorCode' => 'NoValidSnapshot', + 'errorMessage' => 'No snapshots found with given parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"DeleteFileResultList\\": [\\n {\\n \\"Result\\": \\"OK\\",\\n \\"CreateTimestamp\\": 1660638613798\\n }\\n ]\\n}","type":"json"}]', + 'title' => '删除实时截图文件', + ], + 'ListLiveSnapshotJobs' => [ + 'summary' => '调用ListLiveSnapshotJobs获取实时截图任务列表，可分页获取。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。默认为7天前，StartTime与EndTime间隔不能超过30天。', + 'description' => '查询开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'- 默认为7天前。'."\n" + .'- StartTime与EndTime间隔不能超过30天。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。默认为StartTime+7天，StartTime与EndTime间隔不能超过30天。', + 'description' => '查询结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'- 默认为StartTime+7天。'."\n" + .'- StartTime与EndTime间隔不能超过30天。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T23:59:59Z', + ], + ], + [ + 'name' => 'SearchKeyWord', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键词，任务ID/名称，名称支持模糊搜索。', + 'description' => '搜索关键词，任务ID/名称，名称支持模糊搜索。'."\n" + .'- 最大长度为128。', + 'type' => 'string', + 'required' => false, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态过滤，默认查询全部。'."\n" + .'init：未启动'."\n" + .'started：执行中'."\n" + .'paused：已停止', + 'description' => '任务状态过滤，默认查询全部。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'init' => '未启动', + 'paused' => '已停止', + 'started' => '执行中', + ], + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，[1, n)，默认是1。', + 'description' => '页码，[1, n)，默认是1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页宽，[1, 100]，默认是10。', + 'description' => '页宽，[1, 100]，默认是10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序，默认按CreateTime排序，默认是desc。'."\n" + .'asc：升序'."\n" + .'desc：倒序', + 'description' => '排序，按CreateTime排序，默认是desc。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '升序', + 'desc' => '倒序', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据。', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobList' => [ + 'title' => '任务列表。', + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + 'JobName' => [ + 'title' => '任务名称。', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '截图任务1', + ], + 'TemplateId' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****a046-263c-3560-978a-fb287666****', + ], + 'TemplateName' => [ + 'title' => '模板名称。', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '模板1', + ], + 'Status' => [ + 'title' => '任务状态。'."\n" + .'init：未启动'."\n" + .'started：执行中'."\n" + .'paused：已停止', + 'description' => '任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'init' => '未启动', + 'paused' => '已停止', + 'started' => '执行中', + ], + 'example' => 'started', + ], + 'SnapshotOutput' => [ + 'title' => '输出信息。', + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类型，目前只支持oss。', + 'description' => '存储类型，目前只支持oss。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Endpoint' => [ + 'title' => '输出终端，type=oss时返回OSS域名。', + 'description' => '输出终端，type=oss时返回OSS域名。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + 'Bucket' => [ + 'title' => '输出终端的Bucket，type=oss时返回OSS Bucket。', + 'description' => '输出终端的Bucket，type=oss时返回OSS Bucket。', + 'type' => 'string', + 'example' => 'testbucket', + ], + ], + ], + 'TimeInterval' => [ + 'title' => '截图时间间隔。', + 'description' => '截图时间间隔，单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CreateTime' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-07-20T02:48:58Z', + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '页宽。', + 'description' => '页宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SortBy' => [ + 'title' => '排序。', + 'description' => '排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'TotalCount' => [ + 'title' => '总数。', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MalformedStartTime', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'MalformedEndTime', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'EndTimeMismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobList\\": [\\n {\\n \\"JobId\\": \\"****a046-263c-3560-978a-fb287782****\\",\\n \\"JobName\\": \\"截图任务1\\",\\n \\"TemplateId\\": \\"****a046-263c-3560-978a-fb287666****\\",\\n \\"TemplateName\\": \\"模板1\\",\\n \\"Status\\": \\"started\\",\\n \\"SnapshotOutput\\": {\\n \\"StorageType\\": \\"oss\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Bucket\\": \\"testbucket\\"\\n },\\n \\"TimeInterval\\": 5,\\n \\"CreateTime\\": \\"2022-07-20T02:48:58Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '获取实时截图任务列表', + ], + 'ListLiveSnapshotFiles' => [ + 'summary' => '调用ListLiveSnapshotFiles获取实时截图文件列表，可分页获取。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '截图任务ID。', + 'description' => '截图任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****a046-263c-3560-978a-fb287782****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-02-02T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。EndTime和StartTime之间的间隔不能超过1天。', + 'description' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'- EndTime和StartTime之间的间隔不能超过1天。', + 'type' => 'string', + 'required' => true, + 'example' => '2022-02-02T23:59:59Z', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'title' => '每次获取数量，[1, 100]，默认为10。', + 'description' => '每次获取数量，[1, 100]，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序，默认为asc。'."\n" + .'asc：按时间升序'."\n" + .'desc：按时间倒序', + 'description' => '排序，默认为asc。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '按时间升序', + 'desc' => '按时间倒序', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'FileList' => [ + 'title' => '文件列表。', + 'description' => '文件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OssEndpoint' => [ + 'title' => 'OSS域名。', + 'description' => 'OSS域名。', + 'type' => 'string', + 'example' => 'oss-cn-shanghai.aliyuncs.com', + ], + 'OssBucket' => [ + 'title' => 'OSS bucket。', + 'description' => 'OSS bucket。', + 'type' => 'string', + 'example' => 'testbucket', + ], + 'OssObject' => [ + 'title' => 'OSS存储对象位置。', + 'description' => 'OSS存储对象位置。', + 'type' => 'string', + 'example' => 'snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg', + ], + 'CreateTime' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + 'CreateTimestamp' => [ + 'title' => '创建时间戳，用于删除传参。', + 'description' => '创建时间戳，用于删除接口传参。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1619503516000', + ], + 'IsOverlay' => [ + 'title' => '是否覆盖截图。', + 'description' => '是否覆盖截图。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'NextStartTime' => [ + 'title' => '下一页的开始时间，没有返回则表示结束翻页。', + 'description' => '下一页的开始时间，没有返回则表示结束翻页。', + 'type' => 'string', + 'example' => '2022-02-02T22:22:22Z', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'MalformedStartTime', + 'errorMessage' => 'Specified parameter StartTime is not valid.', + ], + [ + 'errorCode' => 'MalformedEndTime', + 'errorMessage' => 'Specified parameter EndTime is not valid.', + ], + [ + 'errorCode' => 'EndTimeMismatch', + 'errorMessage' => 'Specified end time does not math the specified start time.', + ], + ], + 403 => [ + [ + 'errorCode' => 'UserDisable', + 'errorMessage' => 'User is disable.', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'OperationDenied', + 'errorMessage' => 'Your account has not enabled the ICE service.', + ], + ], + [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'No such job.', + ], + [ + 'errorCode' => 'NoValidSnapshot', + 'errorMessage' => 'No snapshots found with given parameters.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"FileList\\": [\\n {\\n \\"OssEndpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"OssBucket\\": \\"testbucket\\",\\n \\"OssObject\\": \\"snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg\\",\\n \\"CreateTime\\": \\"2022-02-02T22:22:22Z\\",\\n \\"CreateTimestamp\\": 1619503516000,\\n \\"IsOverlay\\": true\\n }\\n ],\\n \\"NextStartTime\\": \\"2022-02-02T22:22:22Z\\"\\n}","type":"json"}]', + 'title' => '获取实时截图文件列表', + ], + 'CreateEditingProject' => [ + 'summary' => '创建云剪辑工程，支持设置标题、描述、时间线和工程封面等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程标题', + 'description' => '云剪辑工程标题', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程描述', + 'description' => '云剪辑工程描述', + 'type' => 'string', + 'required' => false, + 'example' => '描述', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => [ + 'title' => '云剪辑工程时间线，Json格式', + 'description' => '云剪辑工程时间线，Json格式', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程封面', + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com/example.png', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模板Id，用于快速低门槛的构建时间线。'."\n" + .'><notice>Timeline、TemplateId有且只有一个非空。当TemplateId不为空时，ClipsParam不能为空。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'ClipsParam', + 'in' => 'query', + 'schema' => [ + 'title' => '模板素材参数', + 'description' => '模板对应的素材参数，Json格式，当TemplateId不为空时，ClipsParam不能为空。具体格式见 [普通模板创建及使用](~~445399~~)、[高级模板创建及使用](~~445389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '见模板使用文档', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型，创建基于模板的云剪辑工程需要填写，默认值：Timeline。'."\n" + .'取值范围：'."\n" + .'- Timeline 普通模板'."\n" + .'- VETemplate 高级模板', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + ], + 'example' => 'Timeline', + ], + ], + [ + 'name' => 'MaterialMaps', + 'in' => 'query', + 'schema' => [ + 'title' => '工程关联素材，多个素材以逗号（,）分隔；每种类型最多支持10个素材ID', + 'description' => '工程关联素材，多个素材以逗号（,）分隔；每种类型最多支持10个素材ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}', + ], + ], + [ + 'name' => 'BusinessConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '工程业务配置。如果是直播剪辑工程必填OutputMediaConfig.StorageLocation, Path 不填默认合成的直播片段存储在根路径下 OutputMediaTarget 不填默认oss-object，可以填vod-media 表示存储到vod OutputMediaTarget 为vod-media 时，Path不生效。', + 'description' => '工程业务配置。一般剪辑工程可忽略。'."\n" + ."\n" + .'- 如果是直播剪辑工程OutputMediaConfig.StorageLocation必填。'."\n" + ."\n" + .'- OutputMediaConfig.Path不填默认合成的直播片段存储在根路径下 '."\n" + ."\n" + .'- OutputMediaTarget 可选填vod-media/oss-object，不填默认oss-object。'."\n" + ."\n" + .'- OutputMediaTarget为vod-media 时，Path不生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', + ], + ], + [ + 'name' => 'ProjectType', + 'in' => 'query', + 'schema' => [ + 'title' => '剪辑工程类型，EditingProject: 普通剪辑工程；LiveEditingProject: 直播剪辑工程', + 'description' => '剪辑工程类型'."\n" + ."\n" + .'- EditingProject：普通剪辑工程。'."\n" + ."\n" + .'- LiveEditingProject：直播剪辑工程。', + 'type' => 'string', + 'required' => false, + 'example' => 'LiveEditingProject', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Project' => [ + 'description' => '云剪辑工程', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'example' => '****01bf24bf41c78b2754cb3187****', + ], + 'Title' => [ + 'title' => '云剪辑工程标题', + 'description' => '云剪辑工程标题', + 'type' => 'string', + 'example' => 'example_title', + ], + 'Description' => [ + 'title' => '云剪辑工程描述', + 'description' => '工程描述', + 'type' => 'string', + 'example' => 'example_description', + ], + 'Timeline' => [ + 'title' => '云剪辑工程时间线，Json格式', + 'description' => '云剪辑工程时间线，Json格式。具体结构定义参见配置[TimeLine](~~198823#topic-2024662~~)说明。当该字段为空时，则创建一个空的时间线，且云剪辑工程的总时长为0。', + 'type' => 'string', + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板Id', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + 'ClipsParam' => [ + 'title' => '模板素材参数', + 'description' => '模板素材参数', + 'type' => 'string', + 'example' => '见模板使用文档', + ], + 'CoverURL' => [ + 'title' => '云剪辑工程封面。', + 'description' => '云剪辑工程封面', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Status' => [ + 'title' => '云剪辑工程状态。 所有云剪辑工程状态列表： -1:Draft -2:Editing -3:Producing -4:Produced -5:ProduceFailed -7:Deleted', + 'description' => '云剪辑工程状态。'."\n" + ."\n" + .'所有云剪辑工程状态列表：'."\n" + ."\n" + .'- 1:Draft'."\n" + ."\n" + .'- 2:Editing'."\n" + ."\n" + .'- 3:Producing'."\n" + ."\n" + .'- 4:Produced'."\n" + ."\n" + .'- 5:ProduceFailed'."\n" + ."\n" + .'- 7:Deleted', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'StatusName' => [ + 'title' => '云剪辑状态名称，对应状态列表中状态名称。', + 'description' => '云剪辑状态名称，对应状态列表中状态名称。', + 'type' => 'string', + 'example' => 'Editing', + ], + 'CreateTime' => [ + 'title' => '云剪辑工程创建时间', + 'description' => '云剪辑工程创建时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:07Z', + ], + 'ModifiedTime' => [ + 'title' => '云剪辑工程编辑时间', + 'description' => '云剪辑工程编辑时间', + 'type' => 'string', + 'example' => '2021-01-08T16:52:07Z', + ], + 'Duration' => [ + 'title' => '云剪辑工程时长', + 'description' => '云剪辑工程时长', + 'type' => 'number', + 'format' => 'float', + 'example' => '3.4200000', + ], + 'CreateSource' => [ + 'title' => '云剪辑工程创建方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole', + 'description' => '云剪辑工程创建方式'."\n" + ."\n" + .'- OpenAPI'."\n" + ."\n" + .'- AliyunConsole'."\n" + ."\n" + .'- WebSDK'."\n" + ."\n" + .'- LiveEditingOpenAPI '."\n" + ."\n" + .'- LiveEditingConsole', + 'type' => 'string', + 'example' => 'WebSDK', + ], + 'ModifiedSource' => [ + 'title' => '云剪辑工程创建方式 -OpenAPI -AliyunConsole -WebSDK -LiveEditingOpenAPI -LiveEditingConsole', + 'description' => '云剪辑工程编辑方式'."\n" + ."\n" + .'- OpenAPI'."\n" + .'- AliyunConsole'."\n" + .'- WebSDK'."\n" + .'- LiveEditingOpenAPI '."\n" + .'- LiveEditingConsole', + 'type' => 'string', + 'example' => 'WebSDK', + ], + 'TemplateType' => [ + 'description' => '云剪辑工程模版类型'."\n" + ."\n" + .'\\-Timeline'."\n" + ."\n" + .'\\-VETemplate', + 'type' => 'string', + 'example' => 'Timeline', + ], + 'BusinessConfig' => [ + 'title' => '工程业务配置', + 'description' => '工程业务配置，一般剪辑工程可忽略', + 'type' => 'string', + 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', + ], + 'ProjectType' => [ + 'title' => '剪辑工程类型，EditingProject: 普通剪辑工程；LiveEditingProject: 直播剪辑工程', + 'description' => '剪辑工程类型，默认EditingProject'."\n" + ."\n" + .'- EditingProject: 普通剪辑工程'."\n" + ."\n" + .'- LiveEditingProject: 直播剪辑工程', + 'type' => 'string', + 'example' => 'LiveEditingProject', + ], + 'BusinessStatus' => [ + 'title' => '业务状态，业务状态 /** 预约中 **/ RESERVING(0, "Reserving"), /** 预约取消 **/ RESERVATION_CANCELED(1, "ReservationCanceled"), /** 直播中 **/ BROADCASTING(3, "BroadCasting"), /** 加载失败 **/ LOADING_FAILED(4, "LoadingFailed"), /** 直播结束 **/ LIVE_FINISHED(5, "LiveFinished");', + 'description' => '工程业务状态，一般剪辑工程可忽略'."\n" + .'- 预约中：Reserving'."\n" + .'- 预约取消：ReservationCanceled '."\n" + .'- 直播中：BroadCasting'."\n" + .'- 加载失败：LoadingFailed'."\n" + .'- 直播结束：LiveFinished', + 'type' => 'string', + 'example' => 'Reserving', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Project\\": {\\n \\"ProjectId\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Title\\": \\"example_title\\",\\n \\"Description\\": \\"example_description\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"ClipsParam\\": \\"见模板使用文档\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Status\\": 2,\\n \\"StatusName\\": \\"Editing\\",\\n \\"CreateTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"ModifiedTime\\": \\"2021-01-08T16:52:07Z\\",\\n \\"Duration\\": 3.42,\\n \\"CreateSource\\": \\"WebSDK\\",\\n \\"ModifiedSource\\": \\"WebSDK\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"ProjectType\\": \\"LiveEditingProject\\",\\n \\"BusinessStatus\\": \\"Reserving\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateEditingProjectResponse>\\n <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>\\n <Project>\\n <ProjectId>****01bf24bf41c78b2754cb3187****</ProjectId>\\n <Title>example_title</Title>\\n <Description>example_description</Description>\\n <Timeline>{\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}</Timeline>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <Status>2</Status>\\n <StatusName>Editing</StatusName>\\n <CreateTime>2021-01-08T16:52:07Z</CreateTime>\\n <ModifiedTime>2021-01-08T16:52:07Z</ModifiedTime>\\n <Duration>3.42</Duration>\\n <CreateSource>WebSDK</CreateSource>\\n <ModifiedSource>WebSDK</ModifiedSource>\\n <TemplateType>Timeline</TemplateType>\\n </Project>\\n</CreateEditingProjectResponse>","errorExample":""}]', + 'title' => '创建云剪辑工程', + 'description' => '- 按照剪辑合成的成片时长计费，详情请参见[视频剪辑](~~2840899~~)<props="china">和[直播剪辑](~~2840900~~)</props>'."\n" + .'。若处理失败，不收取费用。'."\n" + ."\n\n" + .'- 创建剪辑工程后，您可以调用[SubmitMediaProducingJob - 提交剪辑合成作业接口](~~441147~~)提交媒体剪辑合成任务。调用[SubmitLiveEditingJob - 提交直播剪辑任务](~~441148~~)提交直播剪辑任务。', + ], + 'GetEditingProject' => [ + 'summary' => '查询单个云剪辑工程的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'required' => true, + 'example' => '****fb2101bf24b2754cb318787dc****', + ], + ], + [ + 'name' => 'RequestSource', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识'."\n" + ."\n" + .'-OpenAPI：默认，不会做timeline转换操作。'."\n" + ."\n" + .'-WebSDK：若传入该字段，则会自动将工程timeline转换为前端风格，并将timleine中关联素材和工程绑定，供前端websdk预览。', + 'type' => 'string', + 'required' => false, + 'example' => 'WebSDK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Project' => [ + 'description' => '云剪辑工程。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => '****fb2101bf24b2754cb318787dc****', + ], + 'Title' => [ + 'title' => '云剪辑工程标题', + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => '样本title', + ], + 'Timeline' => [ + 'title' => '云剪辑工程时间线', + 'description' => '云剪辑工程时间线。', + 'type' => 'string', + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]}', + ], + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + 'ClipsParam' => [ + 'title' => '模板素材参数', + 'description' => '模板对应的素材参数，Json格式，当TemplateId不为空时，ClipsParam不能为空。具体格式见 [普通模板创建及使用](~~445399~~)、[高级模板创建及使用](~~445389~~)。', + 'type' => 'string', + 'example' => '见模板使用文档', + ], + 'Description' => [ + 'title' => '云剪辑工程描述', + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => '示例描述', + ], + 'CoverURL' => [ + 'title' => '云剪辑工程封面', + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'example' => 'http://aaa.bbb/your-cover.jpg', + ], + 'CreateTime' => [ + 'title' => '云剪辑工程创建时间', + 'description' => '云剪辑工程创建时间。', + 'type' => 'string', + 'example' => '2020-12-20T12:00:00Z', + ], + 'ModifiedTime' => [ + 'title' => '云剪辑工程最新修改时间', + 'description' => '云剪辑工程最新修改时间。', + 'type' => 'string', + 'example' => '2020-12-20T13:00:00Z', + ], + 'Duration' => [ + 'title' => '云剪辑工程总时长', + 'description' => '云剪辑工程总时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24.120000', + ], + 'Status' => [ + 'title' => '云剪辑工程状态', + 'description' => '云剪辑工程状态。'."\n" + .'所有云剪辑工程状态列表：'."\n" + ."\n" + .'\\-Draft'."\n" + ."\n" + .'\\-Editing'."\n" + ."\n" + .'\\-Producing'."\n" + ."\n" + .'\\-Produced'."\n" + ."\n" + .'\\-ProduceFailed'."\n" + ."\n" + .'\\-Deleted', + 'type' => 'string', + 'example' => 'Editing', + ], + 'CreateSource' => [ + 'title' => '云剪辑工程创建来源', + 'description' => '云剪辑工程创建方式'."\n" + ."\n" + .'\\-OpenAPI'."\n" + ."\n" + .'\\-AliyunConsole'."\n" + ."\n" + .'\\-WebSDK'."\n" + ."\n" + .'\\-LiveEditingOpenAPI'."\n" + ."\n" + .'\\-LiveEditingConsole', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'TemplateType' => [ + 'title' => '云剪辑工程模板类型', + 'description' => '云剪辑工程模版类型'."\n" + ."\n" + .'\\-Timeline'."\n" + ."\n" + .'\\-VETemplate', + 'type' => 'string', + 'example' => 'Timeline', + ], + 'ModifiedSource' => [ + 'title' => '云剪辑工程修改来源', + 'description' => '云剪辑工程编辑方式'."\n" + ."\n" + .'\\-OpenAPI'."\n" + ."\n" + .'\\-AliyunConsole'."\n" + ."\n" + .'\\-WebSDK'."\n" + ."\n" + .'\\-LiveEditingOpenAPI'."\n" + ."\n" + .'\\-LiveEditingConsole', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'ProjectType' => [ + 'description' => '剪辑工程类型，默认EditingProject'."\n" + ."\n" + .'\\- EditingProject: 普通剪辑工程'."\n" + ."\n" + .'\\- LiveEditingProject: 直播剪辑工程', + 'type' => 'string', + 'example' => 'EditingProject', + ], + 'BusinessConfig' => [ + 'description' => '工程业务配置，一般剪辑工程可忽略。', + 'type' => 'string', + 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', + ], + 'BusinessStatus' => [ + 'description' => '工程业务状态，一般剪辑工程可忽略'."\n" + ."\n" + .'预约中：Reserving'."\n" + ."\n" + .'预约取消：ReservationCanceled'."\n" + ."\n" + .'直播中：BroadCasting'."\n" + ."\n" + .'加载失败：LoadingFailed'."\n" + ."\n" + .'直播结束：LiveFinished', + 'type' => 'string', + 'example' => 'Reserving', + ], + 'TimelineConvertStatus' => [ + 'description' => '工程转换状态，api风格timeline转换为前端风格timeline是一个异步过程，只有在设置RequestSource:WebSDK时生效。'."\n" + ."\n" + .'-Unconverted：未进行Timeline转换'."\n" + ."\n" + .'-Converting：工程正在转换中'."\n" + ."\n" + .'-Converted：工程转换完成'."\n" + ."\n" + .'-ConvertFailed：工程转换失败', + 'type' => 'string', + 'example' => 'Converted', + ], + 'TimelineConvertErrorMessage' => [ + 'description' => '工程转换失败信息，只有TimelineConvertStatus为ConvertFailed时返回，工程转换的详细失败信息。', + 'type' => 'string', + 'example' => 'The StorageLocation must be in the same division(apiRegion) as ICE service access point.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Project\\": {\\n \\"ProjectId\\": \\"****fb2101bf24b2754cb318787dc****\\",\\n \\"Title\\": \\"样本title\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****9b4d7cf14dc7b83b0e801cbe****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****1656bca4474999c961a6d2a2****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"ClipsParam\\": \\"见模板使用文档\\",\\n \\"Description\\": \\"示例描述\\",\\n \\"CoverURL\\": \\"http://aaa.bbb/your-cover.jpg\\",\\n \\"CreateTime\\": \\"2020-12-20T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2020-12-20T13:00:00Z\\",\\n \\"Duration\\": 24.12,\\n \\"Status\\": \\"Editing\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"BusinessStatus\\": \\"Reserving\\",\\n \\"TimelineConvertStatus\\": \\"Converted\\",\\n \\"TimelineConvertErrorMessage\\": \\"The StorageLocation must be in the same division(apiRegion) as ICE service access point.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetEditingProjectResponse>\\n <RequestId>****63E8B7C7-4812-46AD-0FA56029AC86****</RequestId>\\n <Project>\\n <ProjectId>****fb2101bf24b2754cb318787dc****</ProjectId>\\n <Title>样本title</Title>\\n <Timeline>{\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****9b4d7cf14dc7b83b0e801cbe****\\"},{\\"MediaId\\":\\"****9b4d7cf14dc7b83b0e801cbe****\\"},{\\"MediaId\\":\\"****1656bca4474999c961a6d2a2****\\"}]}]}</Timeline>\\n <Description>示例描述</Description>\\n <CoverURL>oss://example-bucket/example.jpg</CoverURL>\\n <CreateTime>2020-12-20T12:00:00Z</CreateTime>\\n <ModifiedTime>2020-12-20T13:00:00Z</ModifiedTime>\\n <Status>2</Status>\\n <CreateSource>OpenAPI</CreateSource>\\n <TemplateType>Timeline</TemplateType>\\n <ModifiedSource>OpenAPI</ModifiedSource>\\n </Project>\\n</GetEditingProjectResponse>","errorExample":""}]', + 'title' => '获取单个云剪辑工程', + ], + 'UpdateEditingProject' => [ + 'summary' => '修改云剪辑工程，支持修改标题、时间线和封面等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程标题', + 'description' => '云剪辑工程标题', + 'type' => 'string', + 'required' => false, + 'example' => 'testtimeline', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程描述', + 'description' => '云剪辑工程描述', + 'type' => 'string', + 'required' => false, + 'example' => 'testtimeline001desciption', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => [ + 'title' => '云剪辑工程时间线，Json格式', + 'description' => '云剪辑工程时间线，Json格式', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模板Id，用于快速低门槛的构建时间线。><notice>ProjectId、Timeline、TemplateId有且只有一个非空。当TemplateId不为空时，ClipsParam不能为空。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'ClipsParam', + 'in' => 'query', + 'schema' => [ + 'title' => '模板对应的素材参数', + 'description' => '模板对应的素材参数，Json格式，当TemplateId不为空时，ClipsParam不能为空。<props="china">具体格式见 [普通模板创建及使用](~~328557~~)、[高级模板创建及使用](~~291418~~)。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '见模板使用文档', + ], + ], + [ + 'name' => 'CoverURL', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程封面', + 'description' => '云剪辑工程封面', + 'type' => 'string', + 'required' => false, + 'example' => 'https://****.com/6AB4D0E1E1C7446888****.png', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'required' => true, + 'example' => '****4ee4b97e27b525142a6b2****', + ], + ], + [ + 'name' => 'BusinessStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '工程业务状态，一般剪辑工程可忽略。支持修改工程的预约状态：'."\n" + ."\n" + .'- Reserving: 预约中'."\n" + .'- ReservationCanceled: 预约取消'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Reserving', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ProjectNotFound', + 'errorMessage' => 'The specified project not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEditingProjectResponse>\\n <RequestId>****25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n</UpdateEditingProjectResponse>","errorExample":""}]', + 'title' => '修改云剪辑工程', + ], + 'DeleteEditingProjects' => [ + 'summary' => '删除云剪辑工程，支持批量删除。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectIds', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID。支持多个云剪辑工程，以逗号分隔。', + 'description' => '云剪辑工程ID。支持多个云剪辑工程，以逗号分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '****fb2101bf24bf41cb318787dc****,****87dcfb2101bf24bf41cb3187****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****25818875-5F78-4AF6-D7393642CA58****', + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****25818875-5F78-4AF6-D7393642CA58****\\",\\n \\"IgnoredList\\": \\"****fb2101bf24bf41cb318787dc****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEditingProjectsResponse>\\n <RequestId>****25818875-5F78-4AF6-D7393642CA58****</RequestId>\\n <IgnoredList>****fb2101bf24bf41cb318787dc****</IgnoredList>\\n</DeleteEditingProjectsResponse>","errorExample":""}]', + 'title' => '删除云剪辑工程', + ], + 'ListEditingProjects' => [ + 'summary' => '列出符合条件的剪辑工程，支持根据工程创建时间筛选。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182100', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑工程类型：'."\n" + .'- EditingProject: 普通剪辑工程；'."\n" + .'- LiveEditingProject: 直播剪辑工程', + 'type' => 'string', + 'required' => false, + 'example' => 'EditingProject', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型，创建基于模板的云剪辑工程需要填写，默认值：Timeline。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + 'None' => '无', + ], + 'example' => 'None', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-12-21T08:00:01Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'CreationTime（创建时间）的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T23:59:59Z', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，可以根据任务ID搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '******6f36bc45d09a9d5cde49******', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程状态，默认获取所有云剪辑工程。', + 'type' => 'string', + 'required' => false, + 'example' => 'Produced', + ], + ], + [ + 'name' => 'CreateSource', + 'in' => 'query', + 'schema' => [ + 'description' => '创建来源'."\n" + ."\n" + .'- OpenAPI'."\n" + .'- AliyunConsole'."\n" + .'- WebSDK', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。最大不超过100。'."\n" + ."\n" + .'默认值：10', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- CreationTime:Desc（默认值）：按创建时间倒序。'."\n" + .'- CreationTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => 'Nzv3rcKla9wHUGua9YXHNA==', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ProjectList' => [ + 'description' => '云剪辑工程列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****', + ], + 'Title' => [ + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => '工程标题', + ], + 'Description' => [ + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => '工程描述', + ], + 'CoverURL' => [ + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'example' => 'https://xxx.com/cover/xxx.jpg', + ], + 'CreateTime' => [ + 'description' => '云剪辑工程创建时间', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'ModifiedTime' => [ + 'description' => '云剪辑工程最新修改时间。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Status' => [ + 'description' => '所有云剪辑工程状态列表：'."\n" + ."\n" + .'- Draft'."\n" + .'- Editing'."\n" + .'- Producing'."\n" + .'- Produced'."\n" + .'- ProduceFailed', + 'type' => 'string', + 'example' => 'Produced', + ], + 'ErrorCode' => [ + 'description' => '云剪辑工程合成失败的错误码', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'ErrorMessage' => [ + 'description' => '云剪辑工程合成失败的消息', + 'type' => 'string', + 'example' => 'The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.', + ], + 'CreateSource' => [ + 'description' => '云剪辑工程编辑方式'."\n" + ."\n" + .'- OpenAPI'."\n" + .'- AliyunConsole'."\n" + .'- WebSDK', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'ModifiedSource' => [ + 'description' => '最后一次修改来源', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'TemplateType' => [ + 'description' => '模板类型：'."\n" + .'- Timeline 普通模板'."\n" + .'- VETemplate 高级模板', + 'type' => 'string', + 'example' => 'Timeline', + ], + 'ProjectType' => [ + 'description' => '剪辑工程类型：'."\n" + .'- EditingProject: 普通剪辑工程'."\n" + .'- LiveEditingProject: 直播剪辑工程', + 'type' => 'string', + 'example' => 'EditingProject', + ], + 'BusinessConfig' => [ + 'description' => '工程业务配置，一般剪辑工程可忽略', + 'type' => 'string', + 'example' => '{}', + ], + 'BusinessStatus' => [ + 'description' => '工程业务状态，一般剪辑工程可忽略', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"NextToken\\": \\"Nzv3rcKla9wHUGua9YXHNA==\\",\\n \\"MaxResults\\": 10,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Title\\": \\"工程标题\\",\\n \\"Description\\": \\"工程描述\\",\\n \\"CoverURL\\": \\"https://xxx.com/cover/xxx.jpg\\",\\n \\"CreateTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Status\\": \\"Produced\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"The specified parameter \\\\\\\\\\\\\\"LiveStreamConfig\\\\\\\\\\\\\\" is not valid. specified parameter example is not valid.\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{}\\",\\n \\"BusinessStatus\\": \\"{}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列出符合条件的剪辑工程', + ], + 'AddEditingProjectMaterials' => [ + 'summary' => '将一个或多个素材添加到剪辑工程中。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'required' => true, + 'example' => '*****b2101cb318c*****', + ], + ], + [ + 'name' => 'MaterialMaps', + 'in' => 'query', + 'schema' => [ + 'title' => '素材ID', + 'description' => '素材ID，多个素材以逗号（,）分隔；每种类型最多支持10个素材ID'."\n" + .'- "video": 视频'."\n" + .'- "audio": 音频'."\n" + .'- "image": 图片'."\n" + .'- "liveStream": 直播流'."\n" + .'- "editingProject": 剪辑工程', + 'type' => 'string', + 'required' => true, + 'example' => '{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\\"appName\\":\\"testrecord\\",\\"domainName\\":\\"test.alivecdn.com\\",\\"liveUrl\\":\\"rtmp://test.alivecdn.com/testrecord/teststream\\",\\"streamName\\":\\"teststream\\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'ProjectId' => [ + 'description' => '云剪辑项目ID', + 'type' => 'string', + 'example' => '*****67ae06542b9b93e0d1c387*****', + ], + 'MediaInfos' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => '*****5cb2e35433198daae94a72*****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => '媒资基础信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID号', + 'type' => 'string', + 'example' => '*****5cb2e35433198daae94a72*****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型', + 'type' => 'string', + 'example' => 'Video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => 'default_title_2020-12-23T03:32:59Z', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => 'sample_description', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => 'audio', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => 'sample_tag', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => 'userData', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图', + 'type' => 'string', + 'example' => 'null', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '媒资状态'."\n" + ."\n" + .'- Init'."\n" + .'- Preparing'."\n" + .'- PrepareFail'."\n" + .'- Normal', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态', + 'type' => 'string', + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2020-12-23T03:32:59Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2020-12-23T03:32:59Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2020-12-23T03:32:59Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => 'http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfos', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态'."\n" + ."\n" + .'- Uploading'."\n" + .'- Normal'."\n" + .'- UploadFail'."\n" + .'- Disable'."\n" + .'- Deleted', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）', + 'type' => 'string', + 'example' => '30611502', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '216.206667', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1132.68', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '960', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '540', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'LiveMaterials' => [ + 'description' => '直播流关联素材', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '直播播流应用名', + 'type' => 'string', + 'example' => 'testrecord', + ], + 'StreamName' => [ + 'description' => '直播播流流名', + 'type' => 'string', + 'example' => 'teststream', + ], + 'DomainName' => [ + 'description' => '直播播流域名', + 'type' => 'string', + 'example' => 'test.alivecdn.com', + ], + 'LiveUrl' => [ + 'description' => '直播流地址', + 'type' => 'string', + 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', + ], + ], + ], + ], + 'ProjectMaterials' => [ + 'description' => '剪辑工程关联素材。直播工程在直播结束后会关联到一个普通剪辑工程', + 'type' => 'array', + 'items' => [ + 'description' => '直播剪辑工程关联的普通剪辑工程ID', + 'type' => 'string', + 'example' => '*****c38767ae06542b9b93e0d1*****', + ], + 'example' => '*****9b145c5cafc2e057304fcd*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ProjectNotFound', + 'errorMessage' => 'The specified project not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"ProjectId\\": \\"*****67ae06542b9b93e0d1c387*****\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"*****5cb2e35433198daae94a72*****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"*****5cb2e35433198daae94a72*****\\",\\n \\"InputURL\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\",\\n \\"MediaType\\": \\"Video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"default_title_2020-12-23T03:32:59Z\\",\\n \\"Description\\": \\"sample_description\\",\\n \\"Category\\": \\"audio\\",\\n \\"MediaTags\\": \\"sample_tag\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"DeletedTime\\": \\"2020-12-23T03:32:59Z\\",\\n \\"SpriteImages\\": \\"http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"LiveMaterials\\": [\\n {\\n \\"AppName\\": \\"testrecord\\",\\n \\"StreamName\\": \\"teststream\\",\\n \\"DomainName\\": \\"test.alivecdn.com\\",\\n \\"LiveUrl\\": \\"rtmp://test.alivecdn.com/testrecord/teststream\\"\\n }\\n ],\\n \\"ProjectMaterials\\": [\\n \\"*****c38767ae06542b9b93e0d1*****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<AddEditingProjectMaterialsResponse>\\n <RequestId>*****ACB-44F2-5F2D-88D7-1283E70*****</RequestId>\\n <ProjectId>*****67ae06542b9b93e0d1c387*****</ProjectId>\\n <MediaInfos>\\n <MediaId>*****5cb2e35433198daae94a72*****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>*****5cb2e35433198daae94a72*****</MediaId>\\n <InputURL>http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4</InputURL>\\n <MediaType>Video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>default_title_2020-12-23T03:32:59Z</Title>\\n <Description>sample_description</Description>\\n <Category>audio</Category>\\n <MediaTags>sample_tag</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userData</UserData>\\n <Snapshots>null</Snapshots>\\n <Status>Normal</Status>\\n <TranscodeStatus>Init</TranscodeStatus>\\n <CreateTime>2020-12-23T03:32:59Z</CreateTime>\\n <ModifiedTime>2020-12-23T03:32:59Z</ModifiedTime>\\n <DeletedTime>2020-12-23T03:32:59Z</DeletedTime>\\n <SpriteImages>http://outin-example.oss-cn-shanghai.aliyuncs.com/test.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></SpriteImages>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>30611502</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>216.206667</Duration>\\n <Bitrate>1132.68</Bitrate>\\n <Width>960</Width>\\n <Height>540</Height>\\n </FileBasicInfo>\\n </FileInfoList>\\n </MediaInfos>\\n <LiveMaterials>\\n <AppName>testrecord</AppName>\\n <StreamName>teststream</StreamName>\\n <DomainName>test.alivecdn.com</DomainName>\\n <LiveUrl>rtmp://test.alivecdn.com/testrecord/teststream</LiveUrl>\\n </LiveMaterials>\\n <ProjectMaterials>*****c38767ae06542b9b93e0d1*****</ProjectMaterials>\\n</AddEditingProjectMaterialsResponse>","errorExample":""}]', + 'title' => '增加剪辑工程关联素材', + ], + 'GetEditingProjectMaterials' => [ + 'summary' => '获取当前工程绑定的所有素材。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'required' => true, + 'example' => '*****fb2101cb318*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******89-C21D-4B78-AE24-3788B8******', + ], + 'ProjectId' => [ + 'description' => '项目ID号。', + 'type' => 'string', + 'example' => '*****67ae06542b9b93e0d1c387*****', + ], + 'MediaInfos' => [ + 'title' => '符合要求的媒资集合', + 'description' => '符合要求的媒资集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '*****64623a94eca8516569c8fe*****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => '媒资基础信息。', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => '媒资ID。', + 'type' => 'string', + 'example' => '*****64623a94eca8516569c8f*****', + ], + 'InputURL' => [ + 'title' => '待注册的媒资在相应系统中的地址', + 'description' => '待注册的媒资在相应系统中的地址。', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型。', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型。', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源。', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题。', + 'type' => 'string', + 'example' => 'file.mp4', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述。', + 'type' => 'string', + 'example' => 'sample_description', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类。', + 'type' => 'string', + 'example' => 'video', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'string', + 'example' => '标签,tag1', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址。', + 'type' => 'string', + 'example' => 'http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => 'userData', + ], + 'Snapshots' => [ + 'title' => '截图', + 'description' => '截图。', + 'type' => 'string', + 'example' => 'null', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TranscodeStatus' => [ + 'title' => '转码状态', + 'description' => '转码状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TranscodeSuccess' => '转码完成', + 'TranscodeFailed' => '转码失败', + 'Init' => '初始化', + 'Transcoding' => '转码中', + ], + 'example' => 'Init', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => '文件信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等。', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名。', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型。', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）。', + 'type' => 'string', + 'example' => '30611502', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '文件OSS地址。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式。', + 'type' => 'string', + 'example' => 'mov,mp4,m4a,3gp,3g2,mj2', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长。', + 'type' => 'string', + 'example' => '216.206667', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率。', + 'type' => 'string', + 'example' => '1132.68', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽。', + 'type' => 'string', + 'example' => '960', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高。', + 'type' => 'string', + 'example' => '540', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'LiveMaterials' => [ + 'description' => '直播流关联素材。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '直播播流应用名。', + 'type' => 'string', + 'example' => 'testrecord', + ], + 'StreamName' => [ + 'description' => '直播播流流名。', + 'type' => 'string', + 'example' => 'testrecord', + ], + 'DomainName' => [ + 'description' => '直播播流域名。', + 'type' => 'string', + 'example' => 'test.alivecdn.com', + ], + 'LiveUrl' => [ + 'description' => '直播播流地址。', + 'type' => 'string', + 'example' => 'rtmp://test.alivecdn.com/testrecord/teststream', + ], + ], + ], + ], + 'ProjectMaterials' => [ + 'description' => '剪辑工程关联素材。直播工程在直播结束后会关联到一个普通剪辑工程。', + 'type' => 'array', + 'items' => [ + 'description' => '直播剪辑工程关联的普通剪辑工程ID。', + 'type' => 'string', + 'example' => '*****c38767ae06542b9b93e0d1*****', + ], + 'example' => '*****9b145c5cafc2e057304fcd*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ProjectNotFound', + 'errorMessage' => 'The specified project not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******89-C21D-4B78-AE24-3788B8******\\",\\n \\"ProjectId\\": \\"*****67ae06542b9b93e0d1c387*****\\",\\n \\"MediaInfos\\": [\\n {\\n \\"MediaId\\": \\"*****64623a94eca8516569c8fe*****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"*****64623a94eca8516569c8f*****\\",\\n \\"InputURL\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"file.mp4\\",\\n \\"Description\\": \\"sample_description\\",\\n \\"Category\\": \\"video\\",\\n \\"MediaTags\\": \\"标签,tag1\\",\\n \\"CoverURL\\": \\"http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature\\",\\n \\"UserData\\": \\"userData\\",\\n \\"Snapshots\\": \\"null\\",\\n \\"Status\\": \\"Normal\\",\\n \\"TranscodeStatus\\": \\"Init\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"SpriteImages\\": \\"null\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"30611502\\",\\n \\"FileUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mov,mp4,m4a,3gp,3g2,mj2\\",\\n \\"Duration\\": \\"216.206667\\",\\n \\"Bitrate\\": \\"1132.68\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"LiveMaterials\\": [\\n {\\n \\"AppName\\": \\"testrecord\\",\\n \\"StreamName\\": \\"testrecord\\",\\n \\"DomainName\\": \\"test.alivecdn.com\\",\\n \\"LiveUrl\\": \\"rtmp://test.alivecdn.com/testrecord/teststream\\"\\n }\\n ],\\n \\"ProjectMaterials\\": [\\n \\"*****c38767ae06542b9b93e0d1*****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetEditingProjectMaterialsResponse>\\n <RequestId>******89-C21D-4B78-AE24-3788B8******</RequestId>\\n <ProjectId>*****67ae06542b9b93e0d1c387*****</ProjectId>\\n <MediaInfos>\\n <MediaId>*****64623a94eca8516569c8fe*****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>*****64623a94eca8516569c8f*****</MediaId>\\n <InputURL>http://bucket.oss-cn-shanghai.aliyuncs.com/file.mp4</InputURL>\\n <MediaType>video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>file.mp4</Title>\\n <Description>sample_description</Description>\\n <Category>video</Category>\\n <MediaTags>标签,tag1</MediaTags>\\n <CoverURL>http://sample-bucket.oss-cn-shanghai.aliyuncs.com/sample-corver.jpg?Expires=1628670610&OSSAccessKeyId=AK&Signature=signature</CoverURL>\\n <UserData>userData</UserData>\\n <Snapshots>null</Snapshots>\\n <Status>Normal</Status>\\n <TranscodeStatus>Init</TranscodeStatus>\\n <CreateTime>2020-12-26T04:11:08Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:08Z</ModifiedTime>\\n <DeletedTime>2020-12-26T04:11:08Z</DeletedTime>\\n <SpriteImages>null</SpriteImages>\\n </MediaBasicInfo>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>30611502</FileSize>\\n <FileUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mov,mp4,m4a,3gp,3g2,mj2</FormatName>\\n <Duration>216.206667</Duration>\\n <Bitrate>1132.68</Bitrate>\\n <Width>960</Width>\\n <Height>540</Height>\\n </FileBasicInfo>\\n </FileInfoList>\\n </MediaInfos>\\n <LiveMaterials>\\n <AppName>testrecord</AppName>\\n <StreamName>testrecord</StreamName>\\n <DomainName>test.alivecdn.com</DomainName>\\n <LiveUrl>rtmp://test.alivecdn.com/testrecord/teststream</LiveUrl>\\n </LiveMaterials>\\n <ProjectMaterials>*****c38767ae06542b9b93e0d1*****</ProjectMaterials>\\n</GetEditingProjectMaterialsResponse>","errorExample":""}]', + 'title' => '获取剪辑工程关联素材', + ], + 'DeleteEditingProjectMaterials' => [ + 'summary' => '将一个或多个素材从剪辑工程中删除。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'required' => true, + 'example' => '*****fb2101cb318*****', + ], + ], + [ + 'name' => 'MaterialIds', + 'in' => 'query', + 'schema' => [ + 'title' => '素材ID', + 'description' => '素材ID，多个素材以逗号（,）分隔；最多支持10个素材ID', + 'type' => 'string', + 'required' => true, + 'example' => '*****cbd721b418a89a7dafb1dc*****,*****86f5d534c95997c55c96f*****', + ], + ], + [ + 'name' => 'MaterialType', + 'in' => 'query', + 'schema' => [ + 'title' => '素材类型', + 'description' => '素材类型：'."\n" + ."\n" + .'- video'."\n" + .'- image'."\n" + .'- audio'."\n" + .'- subtitle'."\n" + .'- text', + 'type' => 'string', + 'required' => true, + 'example' => 'video', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID号', + 'type' => 'string', + 'example' => '******36-3C1E-4417-BDB2-1E034F******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ProjectNotFound', + 'errorMessage' => 'The specified project not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEditingProjectMaterialsResponse>\\n <RequestId>******36-3C1E-4417-BDB2-1E034F******</RequestId>\\n</DeleteEditingProjectMaterialsResponse>","errorExample":""}]', + 'title' => '删除剪辑工程关联素材', + ], + 'GetLiveEditingIndexFile' => [ + 'summary' => '获取直播流的索引文件，用于控制台剪辑预览。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播播流应用名', + 'type' => 'string', + 'required' => false, + 'example' => 'testrecord', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播播流域名', + 'type' => 'string', + 'required' => false, + 'example' => 'test.alivecdn.com', + ], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '直播播流流名', + 'type' => 'string', + 'required' => false, + 'example' => 'teststream', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '直播剪辑工程ID', + 'type' => 'string', + 'required' => false, + 'example' => '*****cb6307a4edea614d8b3f3c*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'IndexFile' => [ + 'description' => '索引文件地址', + 'type' => 'string', + 'example' => 'https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"IndexFile\\": \\"https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign\\"\\n}","errorExample":""},{"type":"xml","example":"<GetLiveEditingIndexFileResponse>\\n <RequestId>4E84BE44-58A7-****-****-FBEBEA16EF94</RequestId>\\n <IndexFile>https://bucket.oss-cn-shanghai.aliyuncs.com/test/live1.m3u8?<鉴权>&x-oss-process=hls/sign</IndexFile>\\n</GetLiveEditingIndexFileResponse>","errorExample":""}]', + 'title' => '获取直播剪辑索引文件', + ], + 'SubmitProjectExportJob' => [ + 'summary' => '提交工程导出任务。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程ID'."\n" + .'><notice> ProjectId、Timeline 两个参数二选一必填></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '*****67ae06542b9b93e0d1c387*****', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => [ + 'description' => '云剪辑任务时间线。具体结构定义，请参见[Timeline配置说明](~~198823~~)。'."\n" + .'><notice> ProjectId、Timeline 两个参数二选一必填></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '工程导出类型。取值：'."\n" + .'- **BaseTimeline**：时间线。'."\n" + .'- **AdobePremierePro**: Adobe PR 工程。当前仅上海、北京、杭州、深圳区域支持，其余区域不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'BaseTimeline', + ], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '导出结果以及产生的中间文件输出路径，JSON 格式。目前仅支持输出到用户OSS上。包含以下字段：'."\n" + .'- **Bucket**：OSS bucket名称，必填。'."\n" + .'- **Prefix**：生成文件的路径前缀， 非必填，不填时默认为根目录。'."\n" + .'- **Width**: 目标成片的宽，正整数。非必填，不填时根据传入的剪辑工程或者时间线自动估算。'."\n" + .'- **Height**: 目标成片的高，正整数。非必填，不填时根据传入的剪辑工程或者时间线自动估算。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Bucket": "example-bucket",'."\n" + .' "Prefix": "example_prefix",'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义设置，JSON 格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '合成作业Id', + 'description' => '工程导出任务ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', + 'title' => '提交工程导出任务', + ], + 'GetProjectExportJob' => [ + 'summary' => '查询工程导出任务信息。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '工程导出任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + ], + 'ProjectExportJob' => [ + 'description' => '工程导出任务', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '工程导出任务ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****'."\n", + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****'."\n", + ], + 'ExportType' => [ + 'description' => '工程导出类型。取值：'."\n" + .'- **BaseTimeline**：时间线。'."\n" + .'- **AdobePremierePro**: Adobe PR 工程。', + 'type' => 'string', + 'example' => 'BaseTimeline', + ], + 'Status' => [ + 'description' => '工程导出任务状态，取值：'."\n" + .'- **Init**：初始状态'."\n" + .'- **Processing**：处理中'."\n" + .'- **Success**：成功'."\n" + .'- **Failed**：失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'Code' => [ + 'description' => '工程导出任务错误码'."\n" + .'><notice>任务失败时关注该字段></notice>', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Message' => [ + 'description' => '工程导出任务错误信息'."\n" + ."\n" + .'><notice>任务失败时关注该字段></notice>', + 'type' => 'string', + 'example' => 'The specified parameter is not valid.', + ], + 'ExportResult' => [ + 'description' => '导出结果', + 'type' => 'object', + 'properties' => [ + 'Timeline' => [ + 'description' => '云剪辑时间线。当导出类型为BaseTimeline时返回此字段。具体结构定义，请参见[Timeline配置说明](~~198823~~)。', + 'type' => 'string', + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"Type":"Video","MediaId":"****4d7cf14dc7b83b0e801c****","MediaURL":"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4","TimelineIn":0.0,"TimelineOut":5.0,"In":0.0,"Out":5.0,"Speed":1.0,"Duration":5.0,"VirginDuration":13.334,"Height":1.0,"Width":1.0,"X":0.0,"Y":0.0}]}]}', + ], + 'ProjectUrl' => [ + 'description' => '导出工程的文件地址，一般是带鉴权的OSS URL。当导出类型为AdobePremierePro时，返回此字段。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....', + ], + ], + ], + 'UserData' => [ + 'description' => '用户自定义设置，JSON 格式。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"ProjectExportJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\\\n\\",\\n \\"ExportType\\": \\"BaseTimeline\\",\\n \\"Status\\": \\"Success\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"The specified parameter is not valid.\\",\\n \\"ExportResult\\": {\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"Type\\\\\\":\\\\\\"Video\\\\\\",\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\",\\\\\\"MediaURL\\\\\\":\\\\\\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4\\\\\\",\\\\\\"TimelineIn\\\\\\":0.0,\\\\\\"TimelineOut\\\\\\":5.0,\\\\\\"In\\\\\\":0.0,\\\\\\"Out\\\\\\":5.0,\\\\\\"Speed\\\\\\":1.0,\\\\\\"Duration\\\\\\":5.0,\\\\\\"VirginDuration\\\\\\":13.334,\\\\\\"Height\\\\\\":1.0,\\\\\\"Width\\\\\\":1.0,\\\\\\"X\\\\\\":0.0,\\\\\\"Y\\\\\\":0.0}]}]}\\",\\n \\"ProjectUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....\\"\\n },\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\",\\\\\\"Key\\\\\\":\\\\\\"Valuexxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => '查询工程导出任务', + ], + 'SubmitMediaProducingJob' => [ + 'summary' => 'SubmitMediaProducingJob接口主要用于提交一个媒体剪辑合成任务。当用户需要对视频或音频素材进行剪辑、合成或其他形式的后期制作时，可以通过调用此API接口来实现自动化处理。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑工程ld。你可调用[CreateEditingProject](~~441137~~)接口创建剪辑工程，并获取ProjectId 提交剪辑任务。'."\n" + .'><notice>必须填写ProjectId、Timeline、TemplateId三个参数中的一个，剩余两个参数填写为空。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxfb2101cb318xxxxx', + ], + ], + [ + 'name' => 'Timeline', + 'in' => 'formData', + 'schema' => [ + 'description' => '云剪辑任务时间线，当您需要将素材按照视频创意进行编排和特效设计时，可以手动构建Timeline参数。'."\n" + ."\n" + .'- 时间线主要包含轨道、素材、效果3种对象，详情请参见[Timeline配置说明](~~198823~~)。'."\n" + .'- 更多时间线配置示例请参见[最佳实践](~~2766669~~)。'."\n" + ."\n" + .'><notice>必须填写ProjectId、Timeline、TemplateId三个参数中的一个，剩余两个参数填写为空。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板Id，用于快速低门槛的构建时间线。支持基于普通模板和高级模板的视频剪辑。'."\n" + ."\n" + .'- 当使用模板Id提交剪辑合成作业时，必须提供ClipsParam参数，用于灵活调整或替换模板中的素材。'."\n" + ."\n" + .'- 可调用[GetTemplate](~~441164~~)获取模板信息。'."\n" + ."\n" + .'><notice>必须填写ProjectId、Timeline、TemplateId三个参数中的一个，剩余两个参数填写为空。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '****96e8864746a0b6f3****', + ], + ], + [ + 'name' => 'ClipsParam', + 'in' => 'query', + 'schema' => [ + 'description' => '模板对应的素材参数，Json格式，当TemplateId不为空时，ClipsParam不能为空。具体格式见 [普通模板创建及使用](~~445399~~)、[高级模板创建及使用](~~445389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '见模板使用文档', + ], + ], + [ + 'name' => 'ProjectMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑工程的元数据信息，Json格式。具体结构定义参见[ProjectMetadata](~~357745#title-yvp-81k-wff~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Description":"剪辑视频描述","Title":"剪辑标题测试"}', + ], + ], + [ + 'name' => 'OutputMediaTarget', + 'in' => 'query', + 'schema' => [ + 'description' => '输出成品的目标类型。取值：'."\n" + ."\n" + .'- oss-object（客户在阿里云oss bucket下的oss object）'."\n" + ."\n" + .'- vod-media（阿里云vod的媒资）'."\n" + ."\n" + .'- S3（S3 协议输出）', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-object', + ], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '输出成品的目标配置，Json格式。可以设置输出成品的在OSS 上的URL，或者VOD Bucket 中的存储位置。'."\n" + ."\n" + .'- 输出到OSS时，输出目标的 MediaURL 必填；'."\n" + .'- 输出到VOD 时，StorageLocation 和 FileName 两个参数必填。'."\n" + ."\n" + .'[OutputMediaConfig 参数示例](~~357745#title-4j6-ve7-g31~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '{"MediaURL":"https://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，Json格式，长度限制为512字节。支持[任务完成回调配置](~~451631~~)。其中：'."\n" + .'- NotifyAddress为任务完成的回调'."\n" + .'- RegisterMediaNotifyAddress为成片媒资分析完成的回调', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"https://xx.com/xx","RegisterMediaNotifyAddress":"https://xxx.com/xx"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑合成请求来源，取值范围：'."\n" + ."\n" + .'- OpenAPI：API 直接请求。'."\n" + ."\n" + .'- AliyunConsole：请求来自于阿里云控制台。'."\n" + ."\n" + .'- WebSDK：请求来自于集成了WebSDK的前端页面。', + 'type' => 'string', + 'required' => false, + 'example' => 'OPENAPI', + ], + ], + [ + 'name' => 'EditingProduceConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑合成参数，配置详情请参见 [EditingProduceConfig参数详情](~~357745#section-8a4-pb2-hkv~~)。'."\n" + .'> '."\n" + .'>EditingProduceConfig没有配置封面图片时，则默认使用视频的第一帧作为封面。'."\n" + ."\n" + .'- AutoRegisterInputVodMedia：是否需要将您时间线中的VOD媒资自动注册至IMS，默认为true。'."\n" + ."\n" + .'- OutputWebmTransparentChannel: 是否需要输出视频带透明通道，默认为false。'."\n" + ."\n" + .'- CoverConfig: 自定义封面图参数。'."\n" + .'- ......', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "AutoRegisterInputVodMedia": "true",'."\n" + .' "OutputWebmTransparentChannel": "true"'."\n" + .'}', + ], + ], + [ + 'name' => 'MediaMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => '合成视频的元数据，JSON格式。具体结构定义，请参见[MediaMetadata](~~357745#97ff26d0e3c28~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Title":"test-title",'."\n" + .' "Tags":"test-tags1,tags2"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'ProjectId' => [ + 'title' => '剪辑工程Id', + 'description' => '剪辑工程ID。', + 'type' => 'string', + 'example' => '****b4549d46c88681030f6e****', + ], + 'JobId' => [ + 'title' => '合成作业Id', + 'description' => '合成作业ID。', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'MediaId' => [ + 'title' => '合成ICE媒资Id', + 'description' => '合成媒资ID。', + 'type' => 'string', + 'example' => '****c469e944b5a856828dc2****', + ], + 'VodMediaId' => [ + 'title' => 'vod媒资id', + 'description' => '如果视频输出的位置为vod时，返回vod媒资id。', + 'type' => 'string', + 'example' => '****d8s4h75ci975745c14b****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ProjectNotFound', + 'errorMessage' => 'The specified project not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"ProjectId\\": \\"****b4549d46c88681030f6e****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"VodMediaId\\": \\"****d8s4h75ci975745c14b****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitMediaProducingJobResponse>\\n <RequestId>****36-3C1E-4417-BDB2-1E034F****</RequestId>\\n <ProjectId>****b4549d46c88681030f6e****</ProjectId>\\n <JobId>****d80e4e4044975745c14b****</JobId>\\n <MediaId>****c469e944b5a856828dc2****</MediaId>\\n</SubmitMediaProducingJobResponse>","errorExample":""}]', + 'title' => '提交剪辑合成作业', + 'description' => '- **计费说明：视频剪辑按照剪辑合成的成片时长计费，详情请参见[视频剪辑](~~2840899~~)。若处理失败，不收取费用。**'."\n" + ."\n" + .'- 多样化剪辑能力：当您需要将素材按照个性化创意进行编排和设计时，您需要调用该接口，该接口支持通过灵活的[Timeline配置](~~198823~~)，实现复杂的视频剪辑需求。'."\n" + .' '."\n" + .'- 素材引用规则：云剪辑时间线中引用的素材，既可以是素材库中的媒资，也可以直接引用OSS文件，暂不支持外部地址或CDN地址。当素材为OSS文件时，MediaUrl仅支持OSS地址格式，如：https://your-bucket.oss-region-name.aliyuncs.com/your-object.ext。 '."\n" + .'- 异步执行任务：该接口返回合成任务的提交结果，不保证接口返回时视频已合成完毕。合成任务将进入后台排队，异步执行。 '."\n" + ."\n" + .'- 任务状态查询：'."\n" + ."\n" + .' 1. 调用[GetMediaProducingJob](~~441149~~) ，通过传入 JobId 查询任务状态和结果。'."\n" + ."\n" + .' 1. 在提交剪辑合成作业时，您可以在请求参数中设置**UserData**，将其包含回调地址。当剪辑任务完成或失败时，系统会向该回调地址发送通知，您可以通过处理回调数据来了解任务的状态。'."\n" + ."\n" + .'- 媒资注册与分析：视频合成完成后，会自动注册媒资，此时媒资还是分析中状态，当媒资分析完成后，可以根据MediaId获取成片时长及分辨率信息。'."\n" + .'## 使用限制'."\n" + .'- 该接口的流量控制值为30 QPS（每秒提交任务的请求数）。提交的任务会进入后台排队，以异步方式处理。'."\n" + .' >如果超出此限制，可能会遇到 "Throttling.User" 错误。详情请参见： [提交剪辑任务时遇到“Throttling.User”错误](~~453484~~)。'."\n" + ."\n" + .'- 提交大量任务（如1000条、10000条）时，系统会动态扩容，但可能会有一定排队时间。'."\n" + ."\n" + .'- 视频轨、图片轨、字幕轨的轨道数每种均限制最多100个。 '."\n" + .'- 素材个数无限制，素材文件总大小不能超过1 TB。 '."\n" + .'- 输入或输出OSS Bucket所在Region，必须和使用IMS的Region保持一致。 '."\n" + .'- 当输出为视频时，成片分辨率有以下限制：'."\n" + .' - 宽高都不能小于128 px。'."\n" + .' - 宽高都不能大于4096 px。'."\n" + .' - 短边不能大于2160 px。', + 'requestParamsDescription' => '## **OutputMediaConfig 参数示例**'."\n" + .'**示例：输出到 OSS**'."\n" + .'```'."\n" + .'{'."\n" + .' "MediaURL":"https://my-test-bucket.oss-cn-shanghai.aliyuncs.com/test/xxxxxtest001xxxxx.mp4",'."\n" + .' "Bitrate": 2000, '."\n" + .' "Width": 800, '."\n" + .' "Height": 680'."\n" + .'}'."\n" + .'```'."\n" + .'当输出到 OSS 时，MediaURL 必填。OutputMediaTarget 参数默认值为 "oss-object", 表示输出到 OSS。 其他参数可以选填，其中 Bitrate 用来设置输出成品的码率，通常码率越高越清晰，最大可以设置到 5000。 Width, Height 用来设置成品的分辨率。'."\n" + ."\n" + .'OSS URL 的路径格式： https://bucketname.oss-region-name.aliyuncs.com/xxx/yyy.ext'."\n" + ."\n" + .'bucketname 是 OSS Bucket 的名称。'."\n" + ."\n" + .'oss-region-name.aliyuncs.com 是 OSS 文件的外网 Endpoint，比如上海，北京，杭州的分别是：'."\n" + .'```'."\n" + .'oss-cn-shanghai.aliyuncs.com'."\n" + .'oss-cn-hangzhou.aliyuncs.com '."\n" + .'oss-cn-beijing.aliyuncs.com'."\n" + .'```'."\n" + .'**示例：输出到vod**'."\n" + .'```'."\n" + .'{ '."\n" + .' "StorageLocation": "outin-*xxxxxx7d2a3811eb83da00163exxxxxx.oss-cn-shanghai.aliyuncs.com", '."\n" + .' "FileName": "output.mp4", '."\n" + .' "Bitrate": 2000, '."\n" + .' "Width": 800, '."\n" + .' "Height": 680'."\n" + .'}'."\n" + .'```'."\n" + .'当输出到 VOD 时， StorageLocation 和 FileName 两个参数必填。OutputMediaTarget 参数设置为 "vod-media", 表示输出到点播 VOD 的存储Bucket。点播VOD可以使用的存储位置可以在 VOD 里面上传媒资后，在媒资的存储地址中看到。'."\n" + ."\n" + .'**OutputMediaConfig 结构中的参数说明**'."\n" + ."\n" + .'|属性名|类型|描述|'."\n" + .'|:---|:---|:---|'."\n" + .'|MediaURL|String|输出的媒资的 URL （当 OutputMediaTarget 的目标为 oss-object 时， 指定 OSS 文件的 HTTP URL 路径）, 如：http://xxx-bucket-name.oss-cn-shanghai.aliyuncs.com/OSS 跟调用的服务所在区域相同。|'."\n" + .'|StorageLocation|String|当 OutputMediaTarget 的目标为 vod-media 时， 指定 storage location 来存储媒资到 VOD;storage location 是 VOD 中的文件存储位置， 不包含 http:// 的前缀， 如：outin-xxxxxx.oss-cn-shanghai.aliyuncs.com。|'."\n" + .'|FileName|String|当 OutputMediaTarget 的目标为 vod-media 时，指定 fileName（包含文件后缀，不含路径）作为输出文件名。|'."\n" + .'|Width|Integer|输出成品的宽。可以不填，默认值是多个素材的最大宽。|'."\n" + .'|Height|Integer|输出成品的高。可以不填，默认值是多个素材的最大高。|'."\n" + .'|Bitrate|Integer|输出成品的码率，单位为Kbps。可以不填，默认值是多个素材的最高码率，上限为 5000。若还要保留最高素材的码率，需要设置EditingProduceConfig.KeepOriginMaxBitrate=true，详情请参见[EditingProduceConfig](~~357745#section-8a4-pb2-hkv~~)。 |'."\n" + .'|VodTemplateGroupId|String|合成成片输出到vod，指定vod转码模板组。如不需要VOD转码，请填写 "VOD\\_NO_TRANSCODE"。|', + ], + 'GetMediaProducingJob' => [ + 'summary' => '获取剪辑合成作业的详细信息，包括剪辑合成任务的任务状态、时间线、模板及数据等。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑合成作业Id', + 'type' => 'string', + 'required' => false, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', + ], + 'MediaProducingJob' => [ + 'description' => '云剪辑工程信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '剪辑合成作业Id', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程Id', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****', + ], + 'MediaId' => [ + 'description' => '输出成品的资源Id', + 'type' => 'string', + 'example' => '****0cc6ba49eab379332c5b****', + ], + 'MediaURL' => [ + 'description' => '输出成品的资源文件URL', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', + ], + 'Timeline' => [ + 'description' => '剪辑合成作业对应的时间线', + 'type' => 'string', + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + 'TemplateId' => [ + 'description' => '剪辑合成作业对应的模板Id', + 'type' => 'string', + 'example' => '****6e76134d739cc3e85d3e****', + ], + 'ClipsParam' => [ + 'description' => '剪辑合成作业对应的模板参数', + 'type' => 'string', + 'example' => '{"VideoArray":["****05512043f49f697f7425****","****05512043f49f697f7425****","****05512043f49f697f7425****"]}', + ], + 'Duration' => [ + 'description' => '输出成品的时长'."\n" + .'><notice>当合成任务成功且输出成品的类型为音视频时，该字段有值。></notice>', + 'type' => 'number', + 'format' => 'float', + 'example' => '30.500000', + ], + 'CreateTime' => [ + 'description' => '剪辑合成作业创建时间，格式为utc时间。'."\n" + ."\n" + .'格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + 'CompleteTime' => [ + 'description' => '剪辑合成作业完成时间，格式为utc时间。'."\n" + ."\n" + .'格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:52Z', + ], + 'ModifiedTime' => [ + 'description' => '剪辑合成作业修改时间，格式为utc时间。'."\n" + ."\n" + .'格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + 'Status' => [ + 'description' => '剪辑合成作业状态，取值可能为如下值：'."\n" + ."\n" + .'- Init （初始状态）'."\n" + .'- Queuing（排队中）'."\n" + .'- Processing（处理中）'."\n" + .'- Success（成功）'."\n" + .'- Failed（失败）', + 'type' => 'string', + 'example' => 'Failed', + ], + 'Code' => [ + 'description' => '剪辑合成作业错误码'."\n" + .'><notice>作业失败时关注该字段></notice>', + 'type' => 'string', + 'example' => 'ExceededMaximumValue', + ], + 'Message' => [ + 'description' => '剪辑合成作业错误信息'."\n" + ."\n" + .'><notice>作业失败时关注该字段></notice>', + 'type' => 'string', + 'example' => 'The specified "Width_Height" has exceeded maximum value.', + ], + 'VodMediaId' => [ + 'description' => '如果剪辑任务的成片输出到VOD，成片会注册成一个VOD的媒资，vodMediaId 即该媒资在VOD的媒资ID', + 'type' => 'string', + 'example' => '****332c5b0cc6ba49eab379****', + ], + 'UserData' => [ + 'description' => '用户自定义设置，JSON格式。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}', + ], + 'SubJobMaterials' => [ + 'description' => '当该剪辑任务是批量智能一键成片的子任务，返回子任务用到的口播文案、标题等素材信息。', + 'type' => 'string', + 'example' => '{"Title": "标题", "SpeechText": "批量智能一键成片口播文案"}', + ], + 'Progress' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter \\ is not valid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job not found', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"MediaProducingJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"MediaId\\": \\"****0cc6ba49eab379332c5b****\\",\\n \\"MediaURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"TemplateId\\": \\"****6e76134d739cc3e85d3e****\\",\\n \\"ClipsParam\\": \\"{\\\\\\"VideoArray\\\\\\":[\\\\\\"****05512043f49f697f7425****\\\\\\",\\\\\\"****05512043f49f697f7425****\\\\\\",\\\\\\"****05512043f49f697f7425****\\\\\\"]}\\",\\n \\"Duration\\": 30.5,\\n \\"CreateTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"CompleteTime\\": \\"2020-12-23T13:33:52Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"Status\\": \\"Failed\\",\\n \\"Code\\": \\"ExceededMaximumValue\\",\\n \\"Message\\": \\"The specified \\\\\\"Width_Height\\\\\\" has exceeded maximum value.\\",\\n \\"VodMediaId\\": \\"****332c5b0cc6ba49eab379****\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\",\\\\\\"Key\\\\\\":\\\\\\"Valuexxx\\\\\\"}\\",\\n \\"SubJobMaterials\\": \\"{\\\\\\"Title\\\\\\": \\\\\\"标题\\\\\\", \\\\\\"SpeechText\\\\\\": \\\\\\"批量智能一键成片口播文案\\\\\\"}\\",\\n \\"Progress\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMediaProducingJobResponse>\\n <RequestId>****83B7-7F87-4792-BFE9-63CD2137****</RequestId>\\n <MediaProducingJob>\\n <JobId>****cdb3e74639973036bc84****</JobId>\\n <ProjectId>****fddd7748b58bf1d47e95****</ProjectId>\\n <MediaId>****0cc6ba49eab379332c5b****</MediaId>\\n <MediaURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4</MediaURL>\\n <Timeline>{\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}</Timeline>\\n <TemplateId>****6e76134d739cc3e85d3e****</TemplateId>\\n <ClipsParam>{\\"VideoArray\\":[\\"****05512043f49f697f7425****\\",\\"****05512043f49f697f7425****\\",\\"****05512043f49f697f7425****\\"]}</ClipsParam>\\n <Duration>30.5</Duration>\\n <CreateTime>2020-12-23T13:33:40Z</CreateTime>\\n <CompleteTime>2020-12-23T13:33:52Z</CompleteTime>\\n <ModifiedTime>2020-12-23T13:33:49Z</ModifiedTime>\\n <Status>Failed</Status>\\n <Code>ExceededMaximumValue</Code>\\n <Message>The specified \\"Width_Height\\" has exceeded maximum value.</Message>\\n </MediaProducingJob>\\n</GetMediaProducingJobResponse>","errorExample":""}]', + 'title' => '查询剪辑合成作业', + 'description' => '### 使用限制'."\n" + .'本接口仅支持查询近一年的剪辑任务数据。', + ], + 'SubmitLiveEditingJob' => [ + 'summary' => '直播剪辑指将一个或多个直播流区间合成为成品。提交直播剪辑任务后，任务将进入后台排队，异步执行。提交后可以调用查询直播剪辑作业（GeLiveEditingJob ）接口根据 jobId 来查询作业状态。 也可调用获取媒资内容信息（GetMediaInfo）接口根据 MediaId 来查询生成媒资的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Clips', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑片段列表，输出的成片由列表中的片段按顺序收尾拼接而成，JSON Array。'."\n" + ."\n" + .'每一个片段都包含开始时间和结束时间。如果没有直播流参数，则以外层的直播流配置为准。开始和结束时间戳皆为UTC时间。参数详情请见下方 Clip 数据结构。', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" , "AppName": "app", "DomainName": "domain.com", "StreamName": "stream"}, {\\"StartTime\\": \\" 2021-06-21T08:05:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:09:00Z\\" }]', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '直播剪辑工程ID。若非空，读取project相关存储配置。 若为空，则以入参存储配置为准。', + 'type' => 'string', + 'required' => false, + 'example' => '****fddd7748b58bf1d47e95****', + ], + ], + [ + 'name' => 'LiveStreamConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '直播流配置， JSON Object。需包含如下配置项：'."\n" + ."\n" + .'- AppName：播流所属应用名称 '."\n" + ."\n" + .'- DomainName：域名'."\n" + ."\n" + .'- StreamName：直播流名', + 'type' => 'string', + 'required' => false, + 'example' => '{ "AppName": "app", "DomainName": "domain.com", "StreamName": "stream" }', + ], + ], + [ + 'name' => 'OutputMediaConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '输出成品的目标配置，JSON Object。可以设置输出成品的在OSS 上的URL，或者VOD Bucket 中的存储位置。'."\n" + .'- 输出到OSS时，输出目标的MediaURL必填。'."\n" + .'- 输出到VOD时，StorageLocation和FileName两个参数必填。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "MediaURL": "https://ice-auto-test.oss-cn-shanghai.aliyuncs.com/testfile.mp4" }, 或 { "StorageLocation": "bucket.oss-cn-shanghai.aliyuncs.com", "FileName": "output.mp4" }', + ], + ], + [ + 'name' => 'MediaProduceConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '生成片段的合成配置，用JSON格式表示。其中，Mode为剪辑模式，取值：'."\n" + .'- **AccurateFast**（默认值）：快速精剪，相较于Accurate模式合成速度更快。输出文件与源流分辨率一致，不支持指定输出成片宽高。'."\n" + .'- **Accurate**：精确剪辑，可指定输出成片宽高。'."\n" + .'- **Rough**：粗略剪辑，最小精度为一个TS分片，成片包含用户指定起止时间内所有分片，可指定输出成片宽高。'."\n" + .'- **RoughFast**：快速粗剪，相较于Accurate模式合成速度更快，最小精度为一个TS分片，成片包含用户指定起止时间内所有分片。输出文件与源流分辨率一致，不支持指定输出成片宽高。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Mode": "AccurateFast"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，JSON Object，长度限制为512字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"key": "value"}', + ], + ], + [ + 'name' => 'OutputMediaTarget', + 'in' => 'query', + 'schema' => [ + 'description' => '输出成品的目标类型。取值：'."\n" + .'- oss-object 阿里云oss bucket下的oss object'."\n" + .'- vod-media 阿里云vod的媒资', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-object', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'ProjectId' => [ + 'description' => '直播剪辑工程ID。', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****', + ], + 'JobId' => [ + 'description' => '直播剪辑任务ID。', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + 'MediaId' => [ + 'description' => '合成成片媒资ID。', + 'type' => 'string', + 'example' => '****c469e944b5a856828dc2****', + ], + 'MediaURL' => [ + 'description' => '合成成片地址。', + 'type' => 'string', + 'example' => 'http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4', + ], + 'VodMediaId' => [ + 'description' => '如果视频输出的位置为vod时，返回vod媒资ID。', + 'type' => 'string', + 'example' => '****d7578s4h75ci945c14b****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\",\\n \\"MediaId\\": \\"****c469e944b5a856828dc2****\\",\\n \\"MediaURL\\": \\"http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"VodMediaId\\": \\"****d7578s4h75ci945c14b****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitLiveEditingJobResponse>\\n <RequestId>****36-3C1E-4417-BDB2-1E034F****</RequestId>\\n <ProjectId>****fddd7748b58bf1d47e95****</ProjectId>\\n <JobId>****d80e4e4044975745c14b****</JobId>\\n <MediaId>****c469e944b5a856828dc2****</MediaId>\\n <MediaURL>http://test-bucket.cn-shanghai.aliyuncs.com/test.mp4</MediaURL>\\n</SubmitLiveEditingJobResponse>","errorExample":""}]', + 'title' => '提交直播剪辑任务', + 'description' => '当前支持对录制到OSS和VOD的直播流进行直播剪辑。多直播流混剪时，仅支持直播流都录制到OSS或直播流都录制到VOD。', + 'requestParamsDescription' => '### Clip 数据结构'."\n" + ."\n" + .'| 属性名 | 类型 | 示例值 | 描述 | 是否必填'."\n" + .'|-----------|--------|-------------|---------------|----------------|'."\n" + .'| StartTime | String | 2021-06-21T08:01:00Z | 截取片段的开始时间，格式为UTC时间戳 | 是|'."\n" + .'| EndTime | String | 2021-06-21T08:05:00Z | 截取片段的结束时间，格式为UTC时间戳 | 是|'."\n" + .'|AppName | String | app | 播流所属应用名，如果为空，以外层直播流配置为准 | 否|'."\n" + .'|DomainName | String | domain.com | 域名 ，如果为空，以外层直播流配置为准 | 否|'."\n" + .'|StreamName | String | stream | 直播流名，如果为空，以外层直播流配置为准 | 否|'."\n" + .'|CoverTime | String | 2021-06-21T08:03:00Z |指定片段中的某一时间戳，作为成片的封面图，格式为UTC时间戳 。当多个clip 都设置CoverTime参数时，仅第一个生效，CoverTime 必须大于等于StartTime，小于等于Endtime。 | 否 |'."\n" + .'|CoverUrl | String | <ph>https://test.oss-cn-shanghai.aliyuncs.com<ph> | 自定义截图输出地址, OSS bucket 需与服务接入区域保持一致。仅支持自有OSS bucket，不支持VOD 托管bucket。 | 否 |'."\n", + ], + 'GetLiveEditingJob' => [ + 'summary' => '获取剪辑合成作业的详细信息，具体包括剪辑合成任务的任务状态、时间线、模板及数据、输出成品资源ID、存储地址、时长、以及任务其他信息等。'."\n" + .'本接口仅支持查询近一年的直播剪辑任务数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '直播剪辑JobId', + 'description' => '直播剪辑 Jobld', + 'type' => 'string', + 'required' => false, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'LiveEditingJob' => [ + 'title' => '直播剪辑任务', + 'description' => '直播剪辑任务', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '直播剪辑任务ID', + 'description' => '直播剪辑任务ID', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + 'ProjectId' => [ + 'title' => '直播剪辑工程ID', + 'description' => '直播剪辑工程ID', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****', + ], + 'Status' => [ + 'title' => '直播剪辑作业状态，取值可能为如下值： -Init （初始状态） -Queuing（排队中） -Processing（处理中） -Success（成功） -Failed（失败）', + 'description' => '直播剪辑作业状态，取值可能为如下值： '."\n" + ."\n" + .'- Init （初始状态） '."\n" + .'- Queuing（排队中） '."\n" + .'- Processing（处理中） '."\n" + .'- Success（成功）'."\n" + .'- Failed（失败）', + 'type' => 'string', + 'example' => 'Success', + ], + 'Clips' => [ + 'title' => '剪辑片段列表', + 'description' => '剪辑片段列表', + 'type' => 'string', + 'example' => '[{\\"StartTime\\": \\" 2021-06-21T08:01:00Z\\", \\"EndTime\\": \\" 2021-06-21T08:03:00Z\\" }]', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '{"key": "value\'}', + ], + 'CreationTime' => [ + 'title' => '直播剪辑作业创建时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', + 'description' => '直播剪辑作业创建时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + 'ModifiedTime' => [ + 'title' => '直播剪辑作业修改时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', + 'description' => '直播剪辑作业修改时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + 'CompleteTime' => [ + 'title' => '直播剪辑作业完成时间，格式为utc时间。 格式为："2021-06-21T08:01:00Z"。', + 'description' => '直播剪辑作业完成时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:52Z', + ], + 'MediaId' => [ + 'title' => '输出成品的资源Id', + 'description' => '输出成品的资源Id', + 'type' => 'string', + 'example' => '****0cc6ba49eab379332c5b****', + ], + 'MediaURL' => [ + 'title' => '输出成品的资源文件URL', + 'description' => '输出成品的资源文件URL', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4', + ], + 'Code' => [ + 'title' => '剪辑合成作业错误码 注：作业失败时关注该字段', + 'description' => '剪辑合成作业错误码 '."\n" + .'注：作业失败时关注该字段', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Message' => [ + 'title' => '剪辑合成作业错误信息 注：作业失败时关注该字段', + 'description' => '剪辑合成作业错误信息 '."\n" + .'注：作业失败时关注该字段', + 'type' => 'string', + 'example' => 'The specific parameter LiveStreamConfig is not valid.', + ], + 'LiveStreamConfig' => [ + 'title' => '直播剪辑配置', + 'description' => '直播剪辑配置', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'title' => '播流所属应用名称', + 'description' => '播流所属应用名称', + 'type' => 'string', + 'example' => 'app', + ], + 'DomainName' => [ + 'title' => '播流所属域名', + 'description' => '播流所属域名', + 'type' => 'string', + 'example' => 'domain.com', + ], + 'StreamName' => [ + 'title' => '播流所属流名', + 'description' => '播流所属流名', + 'type' => 'string', + 'example' => 'streamName', + ], + ], + ], + 'MediaProduceConfig' => [ + 'title' => '直播剪辑合成配置', + 'description' => '直播剪辑合成配置', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'title' => '剪辑模式，默认Accurate', + 'description' => '剪辑模式，默认Accurate', + 'type' => 'string', + 'example' => 'Accurate', + ], + ], + ], + 'OutputMediaConfig' => [ + 'title' => '输出成片的存储配置', + 'description' => '输出成片的存储配置', + 'type' => 'object', + 'properties' => [ + 'MediaURL' => [ + 'title' => '输出成片的文件地址', + 'description' => '输出成片的文件地址', + 'type' => 'string', + 'example' => 'https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4', + ], + 'StorageLocation' => [ + 'title' => '当 OutputMediaTarget 的目标为 vod-media 时， 指定 storage location 来存储媒资到 VOD; storage location 是 VOD 中的文件存储位置， 不包含 http:// 的前缀， 如: outin-xxxxxx.oss-cn-shanghai.aliyuncs.com', + 'description' => '- 当 OutputMediaTarget 的目标为 vod-media 时， 指定 storage location 来存储媒资到 VOD；'."\n" + .'- storage location 是 VOD 中的文件存储位置， 不包含 http:// 的前缀， 如：outin-xxxxxx.oss-cn-shanghai.aliyuncs.com。', + 'type' => 'string', + 'example' => 'outin-xxxxxx.oss-cn-shanghai.aliyuncs.com', + ], + 'FileName' => [ + 'title' => '当 OutputMediaTarget 的目标为 vod-media 时，指定 fileName(包含文件后缀，不含路径）作为输出文件名', + 'description' => '当 OutputMediaTarget 的目标为 vod-media 时，指定 fileName（包含文件后缀，不含路径）作为输出文件名', + 'type' => 'string', + 'example' => 'test.mp4', + ], + 'Width' => [ + 'title' => '输出成品的宽。可以不填，默认值是多个素材的最大宽', + 'description' => '输出成品的宽。可以不填，默认值是多个素材的最大宽', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '640', + ], + 'Height' => [ + 'title' => '输出成品的高。可以不填，默认值是多个素材的最大高', + 'description' => '输出成品的高。可以不填，默认值是多个素材的最大高', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '480', + ], + 'Bitrate' => [ + 'title' => '输出成品的码率，单位为Kbps。可以不填，默认值是多个素材的最高码率', + 'description' => '输出成品的码率，单位为Kbps。可以不填，默认值是多个素材的最高码率', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'VodTemplateGroupId' => [ + 'title' => '合成成片输出到vod，指定vod转码模板组。如不需要VOD转码，请填写 "VOD_NO_TRANSCODE".', + 'description' => '合成成片输出到vod，指定vod转码模板组。如不需要VOD转码，请填写 "VOD_NO_TRANSCODE".', + 'type' => 'string', + 'example' => 'VOD_NO_TRANSCODE', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"LiveEditingJob\\": {\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\",\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Status\\": \\"Success\\",\\n \\"Clips\\": \\"[{\\\\\\\\\\\\\\"StartTime\\\\\\\\\\\\\\": \\\\\\\\\\\\\\" 2021-06-21T08:01:00Z\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"EndTime\\\\\\\\\\\\\\": \\\\\\\\\\\\\\" 2021-06-21T08:03:00Z\\\\\\\\\\\\\\" }]\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\'}\\",\\n \\"CreationTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"ModifiedTime\\": \\"2020-12-23T13:33:49Z\\",\\n \\"CompleteTime\\": \\"2020-12-23T13:33:52Z\\",\\n \\"MediaId\\": \\"****0cc6ba49eab379332c5b****\\",\\n \\"MediaURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4\\",\\n \\"Code\\": \\"InvalidParameter\\",\\n \\"Message\\": \\"The specific parameter LiveStreamConfig is not valid.\\",\\n \\"LiveStreamConfig\\": {\\n \\"AppName\\": \\"app\\",\\n \\"DomainName\\": \\"domain.com\\",\\n \\"StreamName\\": \\"streamName\\"\\n },\\n \\"MediaProduceConfig\\": {\\n \\"Mode\\": \\"Accurate\\"\\n },\\n \\"OutputMediaConfig\\": {\\n \\"MediaURL\\": \\"https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4\\",\\n \\"StorageLocation\\": \\"outin-xxxxxx.oss-cn-shanghai.aliyuncs.com\\",\\n \\"FileName\\": \\"test.mp4\\",\\n \\"Width\\": 640,\\n \\"Height\\": 480,\\n \\"Bitrate\\": 1000,\\n \\"VodTemplateGroupId\\": \\"VOD_NO_TRANSCODE\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetLiveEditingJobResponse>\\n <RequestId>****36-3C1E-4417-BDB2-1E034F****</RequestId>\\n <LiveEditingJob>\\n <JobId>****cdb3e74639973036bc84****</JobId>\\n <ProjectId>****fddd7748b58bf1d47e95****</ProjectId>\\n <Status>Success</Status>\\n <Clips>[{\\\\\\"StartTime\\\\\\": \\\\\\" 2021-06-21T08:01:00Z\\\\\\", \\\\\\"EndTime\\\\\\": \\\\\\" 2021-06-21T08:03:00Z\\\\\\" }]</Clips>\\n <UserData>{\\"key\\": \\"value\'}</UserData>\\n <CreationTime>2020-12-23T13:33:40Z</CreationTime>\\n <ModifiedTime>2020-12-23T13:33:49Z</ModifiedTime>\\n <CompleteTime>2020-12-23T13:33:52Z</CompleteTime>\\n <MediaId>****0cc6ba49eab379332c5b****</MediaId>\\n <MediaURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example2.mp4</MediaURL>\\n <Code>InvalidParameter</Code>\\n <Message>The specific parameter LiveStreamConfig is not valid.</Message>\\n <LiveStreamConfig>\\n <AppName>app</AppName>\\n <DomainName>domain.com</DomainName>\\n <StreamName>streamName</StreamName>\\n </LiveStreamConfig>\\n <MediaProduceConfig>\\n <Mode>Accurate</Mode>\\n </MediaProduceConfig>\\n <OutputMediaConfig>\\n <MediaURL>https://testice-testbucket.oss-cn-shanghai.aliyuncs.com/test.mp4</MediaURL>\\n <StorageLocation>outin-xxxxxx.oss-cn-shanghai.aliyuncs.com</StorageLocation>\\n <FileName>test.mp4</FileName>\\n <Width>640</Width>\\n <Height>480</Height>\\n <Bitrate>1000</Bitrate>\\n <VodTemplateGroupId>VOD_NO_TRANSCODE</VodTemplateGroupId>\\n </OutputMediaConfig>\\n </LiveEditingJob>\\n</GetLiveEditingJobResponse>","errorExample":""}]', + 'title' => '查询直播剪辑作业', + ], + 'SubmitBatchMediaProducingJob' => [ + 'summary' => '将多个视频、音频、图片素材进行智能混剪，一键批量合成视频。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '131231', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '调用方保证请求幂等性Client Token', + 'description' => '调用方保证请求幂等性Client Token', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****'."\n", + ], + ], + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置。具体结构定义，请参见[InputConfig](~~2692547#2faed1559549n~~)配置说明。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaGroupArray": [{'."\n" + .' "GroupName": "MediaGroup1",'."\n" + .' "MediaArray": ['."\n" + .' "****9d46c886b45481030f6e****",'."\n" + .' "****6c886b4549d481030f6e****" ]'."\n" + .' }, {'."\n" + .' "GroupName": "MediaGroup2",'."\n" + .' "MediaArray": ['."\n" + .' "****d46c886810b454930f6e****",'."\n" + .' "****4549d886810b46c30f6e****" ]'."\n" + .' }],'."\n" + .' "TitleArray": ['."\n" + .' "回龙观盒马鲜生开业啦",'."\n" + .' "盒马鲜生开业啦" ],'."\n" + .' "SpeechTextArray": ['."\n" + .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"'."\n" + .' "商场里的人不少，零食、酒水都比较便宜大家也快来看看呀" ]'."\n" + .'}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '剪辑相关配置。具体结构定义，请参见[EditingConfig](~~2692547#1be9bba03b7qu~~)配置说明。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 0'."\n" + .' },'."\n" + .' "SpeechConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "BackgroundMusicConfig": {'."\n" + .' "Volume": 0.3'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置。具体结构定义，请参见[OutputConfig](~~2692547#447b928fcbuoa~~)配置说明。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 20,'."\n" + .' "MaxDuration": 15,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920,'."\n" + .' "Video": {"Crf": 27}'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置说明](~~357745#section-urj-v3f-0s1~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '模版参数。支持配置多个一键成片模版，随机选取应用。详情见[TemplateConfig参数说明](https://help.aliyun.com/zh/ims/use-cases/batch-video-production-public-parameters?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_5.342860c5H30VVS&scm=20140722.H_2877814._.OR_help-T_cn~zh-V_1#32c3bea6182sy)。', + 'type' => 'string', + 'required' => false, + 'example' => '["****b4549d46c88681030f6e****","****549d46c88b4681030f6e****"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'JobId' => [ + 'title' => '批量混剪任务jobId', + 'description' => '批量智能一键成片作业ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', + 'title' => '批量智能一键成片', + 'description' => '<props="china">'."\n" + ."\n" + .'- 使用智能一键成片需要先购买【IMS订阅服务】，详情请参见[订阅计费制](~~439260#3285adfad70dw~~)。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- 智能一键成片具体计费规则，详情请参见[智能一键成片](~~2840901~~)。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'- 智能一键成片提供【脚本化自动成片】、【智能图文匹配成片-通用场景版】、【智能图文匹配成片-影视集锦版】、【体育赛事集锦成片】、【高燃混剪成片】等多种解决方案，功能详情请参见[智能一键成片](~~2689046~~)。'."\n" + ."\n" + .'- 脚本化自动成片与智能图文匹配成片共用同一个提交任务API。有关如何通过参数区分这两者，请参见[智能一键成片参数区别说明](~~2846101~~)。'."\n" + ."\n" + .'- 提交批量智能一键成片任务后，您可以调用[ListBatchMediaProducingJob](~~2803751~~)获取所有符合条件的一键成片任务列表。调用[GetBatchMediaProducingJob](~~2693269~~)获取任务详细信息，包括任务的状态、合成的媒资ID及URL等。', + ], + 'GetBatchMediaProducingJob' => [ + 'summary' => '获取批量智能一键成片作业的详细信息，包括作业的输入参数、任务状态、合成的媒资ID及URL。本接口仅支持查询近一年的任务数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207313', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '批量智能一键成片作业ID', + 'type' => 'string', + 'required' => false, + 'example' => '****b4549d46c88681030f6e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'EditingBatchJob' => [ + 'description' => '批量智能一键成片任务信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****b6b2750d4308892ac3330238****', + ], + 'InputConfig' => [ + 'description' => '用户合成输出配置。具体结构定义，请参见[InputConfig](~~2692547#2faed1559549n~~)配置说明。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaGroupArray": [{'."\n" + .' "GroupName": "MediaGroup1",'."\n" + .' "MediaArray": ['."\n" + .' "****9d46c886b45481030f6e****",'."\n" + .' "****6c886b4549d481030f6e****" ]'."\n" + .' }, {'."\n" + .' "GroupName": "MediaGroup2",'."\n" + .' "MediaArray": ['."\n" + .' "****d46c886810b454930f6e****",'."\n" + .' "****4549d886810b46c30f6e****" ]'."\n" + .' }],'."\n" + .' "TitleArray": ['."\n" + .' "回龙观盒马鲜生开业啦",'."\n" + .' "盒马鲜生开业啦" ],'."\n" + .' "SpeechTextArray": ['."\n" + .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"'."\n" + .' "商场里的人不少，零食、酒水都比较便宜大家也快来看看呀" ]'."\n" + .'}', + ], + 'EditingConfig' => [ + 'description' => '剪辑相关配置。具体结构定义，请参见[EditingConfig](~~2692547#1be9bba03b7qu~~)配置说明。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 0'."\n" + .' },'."\n" + .' "SpeechConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "BackgroundMusicConfig": {'."\n" + .' "Volume": 0.3'."\n" + .' }'."\n" + .'}', + ], + 'OutputConfig' => [ + 'description' => '输出配置。具体结构定义，请参见[OutputConfig](~~2692547#447b928fcbuoa~~)配置说明。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 20,'."\n" + .' "MaxDuration": 15,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920,'."\n" + .' "Video": {"Crf": 27}'."\n" + .'}', + ], + 'Status' => [ + 'description' => '任务状态。取值范围：'."\n" + ."\n" + .'- Init：初始化'."\n" + ."\n" + .'- Processing：处理中'."\n" + ."\n" + .'- Finished: 处理完成', + 'type' => 'string', + 'example' => 'Finished', + ], + 'UserData' => [ + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData](~~357745#section-urj-v3f-0s1~~)配置说明。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', + ], + 'Extend' => [ + 'description' => '扩展信息。字段详情：'."\n" + ."\n" + .'- ErrorCode: 主任务错误码'."\n" + ."\n" + .'- ErrorMessage: 主任务错误信息', + 'type' => 'string', + 'example' => '{'."\n" + .' "ErrorCode": "InvalidMaterial.NotFound",'."\n" + .' "ErrorMessage": "The specified clips id not found:[\\"****30d0b5e871eebb2ff7f6c75a****\\"]"'."\n" + .'}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，UTC 时间格式', + 'type' => 'string', + 'example' => '2024-06-13T08:47:07Z', + ], + 'ModifiedTime' => [ + 'description' => '任务修改时间，格式为utc时间。'."\n" + ."\n" + .'格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。', + 'type' => 'string', + 'example' => '2024-06-13T08:57:07Z'."\n", + ], + 'CompleteTime' => [ + 'description' => '任务完成时间，格式为utc时间。'."\n" + ."\n" + .'格式为："YYYY-MM-DD\'T\'hh:mm:ss\'Z\'"。', + 'type' => 'string', + 'example' => '2024-06-13T08:57:07Z'."\n", + ], + 'JobType' => [ + 'description' => '任务类型：'."\n" + .'- Script（脚本化自动成片）'."\n" + .'- Smart_Mix（智能图文匹配成片）'."\n" + .'- Sports_Highlights（体育赛事集锦成片）'."\n" + .'- Screen_Media_Highlights（高燃混剪成片）'."\n" + .'- Smart_Mix_Media_Select（智能匹配--素材挑选）'."\n" + .'- Smart_Mix_Timeline_Organize（智能匹配--时间线编排）'."\n" + .'- Screen_Media_Highlights_Media_Select（高燃混剪--素材挑选）'."\n" + .'- Screen_Media_Highlights_Timeline_Organize（高燃混剪--时间线编排）'."\n" + .'- Scene_Batch_Editing（多时间线批量合成）', + 'type' => 'string', + 'example' => 'Script', + ], + 'SubJobList' => [ + 'description' => '一键成片子任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '一键成片子任务信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'description' => '成片媒资ID。', + 'type' => 'string', + 'example' => '****1470b11171ee9d19e7e6c66a****', + ], + 'JobId' => [ + 'description' => '子任务 ID。', + 'type' => 'string', + 'example' => '****8e81933d44e3ae69e2f81485****', + ], + 'MediaURL' => [ + 'description' => '输出成片的文件地址', + 'type' => 'string', + 'example' => 'http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4', + ], + 'Status' => [ + 'description' => '子任务状态。取值范围：'."\n" + ."\n" + .'- Init：初始化'."\n" + ."\n" + .'- Processing：处理中'."\n" + ."\n" + .'- Success：成功'."\n" + ."\n" + .'- Failed： 失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrorCode' => [ + 'description' => '失败时错误码。如果执行成功则不返回此参数。', + 'type' => 'string', + 'example' => 'InvalidMaterial.NotFound', + ], + 'ErrorMessage' => [ + 'description' => '失败时错误信息。如成功则不返回此参数。', + 'type' => 'string', + 'example' => 'The specified clips id not found:["****30d0b5e871eebb2ff7f6c75a****"]', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => '****7cc47fe04eaa81bd853acb6a****', + ], + 'Duration' => [ + 'description' => '成片时长，单位：秒（s）。', + 'type' => 'number', + 'format' => 'float', + 'example' => '24.5', + ], + ], + ], + ], + 'ExtendInput' => [ + 'description' => '额外输入。'."\n" + .'- JobType = Smart_Mix_Timeline_Organize 或 Screen_Media_Highlights_Timeline_Organize 时，额外输入为素材挑选结果。'."\n" + .'- JobType = Scene_Batch_Editing 时，额外输入为剪辑工程id列表。', + 'type' => 'string', + 'example' => '["****7cc47fe04eaa81bd853acb6a****", "****04eaa7cc47fe81bd853acb6a****"]', + ], + 'ExtendOutput' => [ + 'description' => '额外输出。'."\n" + .'- JobType = Smart_Mix_Media_Select 或 Screen_Media_Highlights_Media_Select 时，额外返回素材挑选结果。', + 'type' => 'string', + 'example' => '{'."\n" + .' "textMatchMediaOutputList": [{'."\n" + .' "textMatchMediaSentenceOutputList": [{'."\n" + .' "duration": 3.366667,'."\n" + .' "matchClipList": [{'."\n" + .' "clipId": "null-2",'."\n" + .' "endTime": 11.16,'."\n" + .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .' "score": -0.253,'."\n" + .' "startTime": 8.04'."\n" + .' }],'."\n" + .' "text": "附近的商场新开了一家盒马鲜生",'."\n" + .' "textId": "0"'."\n" + .' },'."\n" + .' {'."\n" + .' "duration": 1.566667,'."\n" + .' "matchClipList": [{'."\n" + .' "clipId": "null-1",'."\n" + .' "endTime": 1.54,'."\n" + .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .' "score": -0.2326,'."\n" + .' "startTime": 0'."\n" + .' }],'."\n" + .' "text": "今天是第一天开业",'."\n" + .' "textId": "0"'."\n" + .' }'."\n" + .' ]'."\n" + .' }]'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"EditingBatchJob\\": {\\n \\"JobId\\": \\"****b6b2750d4308892ac3330238****\\",\\n \\"InputConfig\\": \\"{\\\\n \\\\\\"MediaGroupArray\\\\\\": [{\\\\n \\\\\\"GroupName\\\\\\": \\\\\\"MediaGroup1\\\\\\",\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****9d46c886b45481030f6e****\\\\\\",\\\\n \\\\\\"****6c886b4549d481030f6e****\\\\\\" ]\\\\n }, {\\\\n \\\\\\"GroupName\\\\\\": \\\\\\"MediaGroup2\\\\\\",\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****d46c886810b454930f6e****\\\\\\",\\\\n \\\\\\"****4549d886810b46c30f6e****\\\\\\" ]\\\\n }],\\\\n \\\\\\"TitleArray\\\\\\": [\\\\n \\\\\\"回龙观盒马鲜生开业啦\\\\\\",\\\\n \\\\\\"盒马鲜生开业啦\\\\\\" ],\\\\n \\\\\\"SpeechTextArray\\\\\\": [\\\\n \\\\\\"附近的商场新开了一家盒马鲜生，今天是第一天开业\\\\\\"\\\\n \\\\\\"商场里的人不少，零食、酒水都比较便宜大家也快来看看呀\\\\\\" ]\\\\n}\\",\\n \\"EditingConfig\\": \\"{\\\\n \\\\\\"MediaConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0\\\\n },\\\\n \\\\\\"SpeechConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 1\\\\n },\\\\n \\\\\\"BackgroundMusicConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0.3\\\\n }\\\\n}\\",\\n \\"OutputConfig\\": \\"{\\\\n \\\\\\"MediaURL\\\\\\": \\\\\\"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\\\\\\",\\\\n \\\\\\"Count\\\\\\": 20,\\\\n \\\\\\"MaxDuration\\\\\\": 15,\\\\n \\\\\\"Width\\\\\\": 1080,\\\\n \\\\\\"Height\\\\\\": 1920,\\\\n \\\\\\"Video\\\\\\": {\\\\\\"Crf\\\\\\": 27}\\\\n}\\",\\n \\"Status\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\",\\n \\"Extend\\": \\"{\\\\n\\\\t\\\\\\"ErrorCode\\\\\\": \\\\\\"InvalidMaterial.NotFound\\\\\\",\\\\n\\\\t\\\\\\"ErrorMessage\\\\\\": \\\\\\"The specified clips id not found:[\\\\\\\\\\\\\\"****30d0b5e871eebb2ff7f6c75a****\\\\\\\\\\\\\\"]\\\\\\"\\\\n}\\",\\n \\"CreateTime\\": \\"2024-06-13T08:47:07Z\\",\\n \\"ModifiedTime\\": \\"2024-06-13T08:57:07Z\\\\n\\",\\n \\"CompleteTime\\": \\"2024-06-13T08:57:07Z\\\\n\\",\\n \\"JobType\\": \\"Script\\",\\n \\"SubJobList\\": [\\n {\\n \\"MediaId\\": \\"****1470b11171ee9d19e7e6c66a****\\",\\n \\"JobId\\": \\"****8e81933d44e3ae69e2f81485****\\",\\n \\"MediaURL\\": \\"http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4\\",\\n \\"Status\\": \\"Success\\",\\n \\"ErrorCode\\": \\"InvalidMaterial.NotFound\\",\\n \\"ErrorMessage\\": \\"The specified clips id not found:[\\\\\\"****30d0b5e871eebb2ff7f6c75a****\\\\\\"]\\",\\n \\"ProjectId\\": \\"****7cc47fe04eaa81bd853acb6a****\\",\\n \\"Duration\\": 24.5\\n }\\n ],\\n \\"ExtendInput\\": \\"[\\\\\\"****7cc47fe04eaa81bd853acb6a****\\\\\\", \\\\\\"****04eaa7cc47fe81bd853acb6a****\\\\\\"]\\",\\n \\"ExtendOutput\\": \\"{\\\\n\\\\t\\\\\\"textMatchMediaOutputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"textMatchMediaSentenceOutputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"duration\\\\\\": 3.366667,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"clipId\\\\\\": \\\\\\"null-2\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"endTime\\\\\\": 11.16,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"score\\\\\\": -0.253,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"startTime\\\\\\": 8.04\\\\n\\\\t\\\\t\\\\t\\\\t}],\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"text\\\\\\": \\\\\\"附近的商场新开了一家盒马鲜生\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"duration\\\\\\": 1.566667,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"matchClipList\\\\\\": [{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"clipId\\\\\\": \\\\\\"null-1\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"endTime\\\\\\": 1.54,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"mediaId\\\\\\": \\\\\\"****a0900f5071efbf1ce7e6c66a****\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"score\\\\\\": -0.2326,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"startTime\\\\\\": 0\\\\n\\\\t\\\\t\\\\t\\\\t}],\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"text\\\\\\": \\\\\\"今天是第一天开业\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"textId\\\\\\": \\\\\\"0\\\\\\"\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t]\\\\n\\\\t}]\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取批量智能一键成片任务信息', + ], + 'SubmitSportsHighlightsJob' => [ + 'summary' => '输入包含解说的体育赛事素材，自动生成体育赛事集锦视频。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '235590', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '调用方保证请求幂等性Client Token', + 'description' => '调用方保证请求幂等性Client Token', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****'."\n", + ], + ], + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置，详见：[ InputConfig 参数说明](~~2843158#5cbc796a9cuu8~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SportsCategory": "basketball",'."\n" + .' "InputMedia": "http://test-bucket.oss-cn-******.basketball-0707.mp4",'."\n" + .' "FaceRegister": ['."\n" + .' {'."\n" + .' "FaceUrls": ["http://testcdn.com/front.jpg", "http://testcdn.com/side.jpg"],'."\n" + .' "Name": "James"'."\n" + .' }'."\n" + .' ],'."\n" + .' "SlowMotionLogoRegister": {'."\n" + .' "SlowMotionLogoUrls": ["http://testcdn.com/logo1.jpg", "http://testcdn.com/logo2.jpg"]'."\n" + .' },'."\n" + .' "TransferNameRegister": ['."\n" + .' {'."\n" + .' "OriginalName": "IND",'."\n" + .' "TransferName": "印第安纳步行者"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置，详见：[OutputConfig 参数说明](~~2843158#b7dad99fe5q0r~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置](~~357745~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****'."\n", + ], + 'JobId' => [ + 'description' => '体育集锦作业ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\\\n\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\\\n\\"\\n}","type":"json"}]', + 'title' => '提交体育集锦任务', + ], + 'SubmitScreenMediaHighlightsJob' => [ + 'summary' => '输入短剧等影视素材，自动识别高光片段，合成高燃成片。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置，详见：[InputConfig参数说明](~~2863940#dda38bf6ec2pk~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaArray": ['."\n" + .' "****9d46c886b45481030f6e****",'."\n" + .' "****6c886b4549d481030f6e****"'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '剪辑配置，详见：[EditingConfig参数说明](~~2863940#9b05519d46e0x~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "ProcessConfig": {'."\n" + .' "AllowTransition": true,'."\n" + .' "TransitionList": ["fadecolor"]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置，详见：[OutputConfig参数说明](~~2863940#4111a373d0xbz~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置](~~357745~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'JobId' => [ + 'description' => '高燃成片任务ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\"\\n}","type":"json"}]', + 'title' => '提交高燃混剪任务', + ], + 'ListMediaProducingJobs' => [ + 'summary' => '列出符合条件的合成任务，可根据任务状态、类型查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '12624', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '查询以下状态的合成任务，支持多值，以英文逗号分隔', + 'description' => '合成任务状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Init' => '任务初始化', + 'Failed' => '合成失败', + 'Success' => '合成成功', + 'Processing' => '合成中', + ], + 'example' => 'Success', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LiveEditingJob' => '直播剪辑任务', + 'EditingJob' => '普通剪辑任务', + 'VETemplateJob' => '高级模板剪辑任务', + ], + 'example' => 'EditingJob', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间，与StartTime相差不超过30天。格式为yyyy-mm-ddthh:mm:ssz（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T23:59:59Z', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，可以根据任务ID搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '云剪辑工程id', + 'type' => 'string', + 'required' => false, + 'example' => '******927cfb53d05b96c1bfe1******', + ], + ], + [ + 'name' => 'MasterJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '一键成片任务Id，当此条件不为空时，为查询一键成片任务的子任务。', + 'type' => 'string', + 'required' => false, + 'example' => '******8750b54e3c976a47da6f******', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当前开始读取的位置', + 'type' => 'string', + 'required' => false, + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreationTime:Asc' => '按照创建时间正序', + 'CreationTime:Desc' => '按照创建时间倒序', + ], + 'example' => 'CreationTime:Desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaProducingJobList' => [ + 'description' => '剪辑任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '剪辑任务列表', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '云剪辑任务id', + 'type' => 'string', + 'example' => '******8750b54e3c976a47da6f******', + ], + 'ProjectId' => [ + 'description' => '云剪辑工程id', + 'type' => 'string', + 'example' => '******faa3b542f5a6135217e3******', + ], + 'MediaId' => [ + 'description' => '输出成品的资源id', + 'type' => 'string', + 'example' => '0ce4ea70f52471edab61f7e7d6786302', + ], + 'MediaURL' => [ + 'description' => '输出成品的资源文件URL', + 'type' => 'string', + 'example' => 'http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4', + ], + 'TemplateId' => [ + 'description' => '云剪辑模板ID', + 'type' => 'string', + 'example' => 'cb786a39c5d44cecb23d8c864facffc1', + ], + 'ClipsParam' => [ + 'description' => '模板素材参数', + 'type' => 'string', + 'example' => '{"Text1":"text","Text0":"text","Media1":"mediaId","Media0":"mediaId"}', + ], + 'Duration' => [ + 'description' => '输出成品的时长，单位：秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '15.5', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2022-03-21T16:40:00Z', + ], + 'CompleteTime' => [ + 'description' => '剪辑合成作业完成时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2022-03-21T16:40:30Z', + ], + 'ModifiedTime' => [ + 'description' => '最后更新时间。', + 'type' => 'string', + 'example' => '2022-03-21T16:41:00Z', + ], + 'Status' => [ + 'description' => '剪辑合成作业状态', + 'type' => 'string', + 'example' => 'Sucess', + ], + 'Code' => [ + 'description' => '剪辑合成作业失败错误码', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '剪辑合成作业错误信息注：作业失败时关注该字段', + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'UserData' => [ + 'description' => '用户自定义设置', + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'string', + 'example' => '100', + ], + 'NextToken' => [ + 'description' => '当前开始读取的位置', + 'type' => 'string', + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaProducingJobList\\": [\\n {\\n \\"JobId\\": \\"******8750b54e3c976a47da6f******\\",\\n \\"ProjectId\\": \\"******faa3b542f5a6135217e3******\\",\\n \\"MediaId\\": \\"0ce4ea70f52471edab61f7e7d6786302\\",\\n \\"MediaURL\\": \\"http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4\\",\\n \\"TemplateId\\": \\"cb786a39c5d44cecb23d8c864facffc1\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\",\\\\\\"Text0\\\\\\":\\\\\\"text\\\\\\",\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Media0\\\\\\":\\\\\\"mediaId\\\\\\"}\\",\\n \\"Duration\\": 15.5,\\n \\"CreateTime\\": \\"2022-03-21T16:40:00Z\\",\\n \\"CompleteTime\\": \\"2022-03-21T16:40:30Z\\",\\n \\"ModifiedTime\\": \\"2022-03-21T16:41:00Z\\",\\n \\"Status\\": \\"Sucess\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": \\"100\\",\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\"\\n}","type":"json"}]', + 'title' => '列出符合条件的剪辑合成任务', + ], + 'ListBatchMediaProducingJobs' => [ + 'summary' => '列出符合条件的一键成片任务，可以根据任务类型、状态等条件查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '216608', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '一键成片任务Id', + 'type' => 'string', + 'required' => false, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型：'."\n" + .'- Script（脚本化素材混剪）'."\n" + .'- Smart_Mix（智能混编素材混剪）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Script' => '脚本化素材混剪', + 'Smart_Mix' => '智能混编素材混剪', + ], + 'example' => 'Script', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态：'."\n" + .'- Finished（处理完成）'."\n" + .'- Init（初始化）'."\n" + .'- Failed（失败）'."\n" + .'- Processing（处理中）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Finished' => '处理完成', + 'Init' => '初始化', + 'Failed' => '失败', + 'Processing' => '处理中', + ], + 'example' => 'Finished', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-02-02T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。UTC时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-05T15:59:59Z', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果排序。取值：'."\n" + ."\n" + .'- desc（默认值）：按创建时间倒序。'."\n" + .'- asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '按照创建时间正序', + 'desc' => '按照创建时间倒序', + ], + 'example' => 'desc', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'required' => false, + 'example' => 'mRZkKAovub0xWVfH14he4Q==', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'EditingBatchJobList' => [ + 'description' => '一键成片任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '一键成片任务列表', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '一键成片任务 Id', + 'type' => 'string', + 'example' => '******7ecbee4c6d9b8474498e******', + ], + 'InputConfig' => [ + 'description' => '用户合成输出配置。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaGroupArray": [{'."\n" + .' "MediaArray": ['."\n" + .' "****9d46c886b45481030f6e****",'."\n" + .' "****6c886b4549d481030f6e****" ]'."\n" + .' }, {'."\n" + .' "MediaArray": ['."\n" + .' "****d46c886810b454930f6e****",'."\n" + .' "****4549d886810b46c30f6e****" ]'."\n" + .' }],'."\n" + .' "TitleArray": ['."\n" + .' "回龙观盒马鲜生开业啦"],'."\n" + .' "SpeechTextArray": ['."\n" + .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"]'."\n" + .'}', + ], + 'EditingConfig' => [ + 'description' => '剪辑相关配置。具体结构定义，请参见[EditingConfig](~~2692547#1be9bba03b7qu~~)配置说明。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 0'."\n" + .' },'."\n" + .' "SpeechConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "BackgroundMusicConfig": {'."\n" + .' "Volume": 0.3'."\n" + .' }'."\n" + .'}', + ], + 'OutputConfig' => [ + 'description' => '输出配置。具体结构定义，请参见[OutputConfig](~~2692547#447b928fcbuoa~~)配置说明。', + 'type' => 'string', + 'example' => '{'."\n" + .' "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 20,'."\n" + .' "MaxDuration": 15,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920,'."\n" + .' "Video": {"Crf": 27}'."\n" + .'}', + ], + 'Status' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finished' => '处理完成', + 'Init' => '初始化', + 'Failed' => '失败', + 'Processing' => '处理中', + ], + 'example' => 'Finished', + ], + 'UserData' => [ + 'description' => '自定义设置，Json 格式，长度限制为 512 字节。支持[自定义回调地址配置](~~451631#section-fbd-xz2-xum~~)。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + 'Extend' => [ + 'description' => '任务扩展信息', + 'type' => 'string', + 'example' => '{}', + ], + 'CreateTime' => [ + 'description' => '创建时间，UTC 时间格式', + 'type' => 'string', + 'example' => '2023-06-09T06:36:48Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-06-09T06:37:58Z', + ], + 'CompleteTime' => [ + 'description' => '完成时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '2023-06-09T06:38:09Z'."\n", + ], + 'JobType' => [ + 'description' => '任务类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Script' => '脚本化素材混剪', + 'Smart_Mix' => '智能混编素材混剪', + ], + 'example' => 'Script', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '下一次查询的开始Token。', + 'type' => 'string', + 'example' => '8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + 'MaxResults' => [ + 'description' => '分页大小。最大不超过100。'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"EditingBatchJobList\\": [\\n {\\n \\"JobId\\": \\"******7ecbee4c6d9b8474498e******\\",\\n \\"InputConfig\\": \\"{\\\\n \\\\\\"MediaGroupArray\\\\\\": [{\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****9d46c886b45481030f6e****\\\\\\",\\\\n \\\\\\"****6c886b4549d481030f6e****\\\\\\" ]\\\\n }, {\\\\n \\\\\\"MediaArray\\\\\\": [\\\\n \\\\\\"****d46c886810b454930f6e****\\\\\\",\\\\n \\\\\\"****4549d886810b46c30f6e****\\\\\\" ]\\\\n }],\\\\n \\\\\\"TitleArray\\\\\\": [\\\\n \\\\\\"回龙观盒马鲜生开业啦\\\\\\"],\\\\n \\\\\\"SpeechTextArray\\\\\\": [\\\\n \\\\\\"附近的商场新开了一家盒马鲜生，今天是第一天开业\\\\\\"]\\\\n}\\",\\n \\"EditingConfig\\": \\"{\\\\n \\\\\\"MediaConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0\\\\n },\\\\n \\\\\\"SpeechConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 1\\\\n },\\\\n \\\\\\"BackgroundMusicConfig\\\\\\": {\\\\n \\\\\\"Volume\\\\\\": 0.3\\\\n }\\\\n}\\",\\n \\"OutputConfig\\": \\"{\\\\n \\\\\\"MediaURL\\\\\\": \\\\\\"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\\\\\\",\\\\n \\\\\\"Count\\\\\\": 20,\\\\n \\\\\\"MaxDuration\\\\\\": 15,\\\\n \\\\\\"Width\\\\\\": 1080,\\\\n \\\\\\"Height\\\\\\": 1920,\\\\n \\\\\\"Video\\\\\\": {\\\\\\"Crf\\\\\\": 27}\\\\n}\\",\\n \\"Status\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}或{\\\\\\"NotifyAddress\\\\\\":\\\\\\"https://xx.xx.xxx\\\\\\"}或{\\\\\\"NotifyAddress\\\\\\":\\\\\\"ice-callback-demo\\\\\\"}\\",\\n \\"Extend\\": \\"{}\\",\\n \\"CreateTime\\": \\"2023-06-09T06:36:48Z\\",\\n \\"ModifiedTime\\": \\"2023-06-09T06:37:58Z\\",\\n \\"CompleteTime\\": \\"2023-06-09T06:38:09Z\\\\n\\",\\n \\"JobType\\": \\"Script\\"\\n }\\n ],\\n \\"NextToken\\": \\"8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"MaxResults\\": 100\\n}","type":"json"}]', + 'title' => '列出符合条件的一键成片任务', + ], + 'AddTemplate' => [ + 'summary' => '智能生产制作支持基于普通模板和高级模板的视频剪辑功能，用户可调用AddTemplate创建模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '自定义模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模板名称', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型，取值范围：Timeline', + 'description' => '模板类型，目前支持： '."\n" + .'- Timeline（普通模板）：基于视频剪辑工程的Timeline（时间线内多个素材，多图层形式进行前后拼接）创建的模板，可实现图文转视频、图片相册、片头片尾、默认水印等效果。'."\n" + .'- VETemplate（高级模板）：基于AE（Adobe After Effects）特效创建的模板，可实现复杂动效样式的高级媒体效果。'."\n" + .'- BatchEditing (一键成片模版)：支持配置贴纸水印、背景音乐、背景图片、口播字幕样式、标题字幕样式、输出分辨率等参数，提交一键成片任务时自动应用。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + ], + 'example' => 'Timeline', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'title' => '参见Timeline模板Config文档', + 'description' => '- 普通模板Config是基于云剪辑Timeline的封装，自定义模板Config会更加灵活。如果您有特殊需求，建议熟悉Config结构并自定义模板，详情请参见[普通模板Config详解](~~456193~~)。'."\n" + .'- 更多模板Config示例，请参见[常见普通模板Config示例](~~451634~~)。'."\n" + .'- 一键成片模版Config配置，请参见[一键成片模版配置参数说明](~~2878274~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '参见Timeline模板Config文档', + ], + ], + [ + 'name' => 'CoverUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '模板封面', + 'description' => '模板封面', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', + ], + ], + [ + 'name' => 'PreviewMedia', + 'in' => 'query', + 'schema' => [ + 'title' => '预览视频媒资id', + 'description' => '模板预览视频MediaId', + 'type' => 'string', + 'required' => false, + 'example' => '****01bf24bf41c78b2754cb3187****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '模板状态', + 'description' => '模板状态，取值范围：'."\n" + .'- Available：正常'."\n" + .'- Created：已创建还不能使用'."\n" + .'- Uploading：上传中'."\n" + .'- Processing：高级模板分析中'."\n" + .'- UploadFailed：上传失败'."\n" + .'- ProcessFailed：高级模板分析失败', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UploadFailed' => '上传失败', + 'ProcessFailed' => '高级模板分析失败', + 'Available' => '正常', + 'Uploading' => '上传中', + 'Created' => '已创建，还不能使用', + 'Processing' => '高级模板分析中', + ], + 'example' => 'Available', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '模板创建来源，默认OpenAPI', + 'description' => '模板创建来源，取值范围：'."\n" + .'- OpenAPI：通过OpenAPI创建'."\n" + .'- AliyunConsole：通过阿里云控制台创建'."\n" + .'- WebSDK：通过WebSDK创建', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + ], + [ + 'name' => 'RelatedMediaids', + 'in' => 'query', + 'schema' => [ + 'title' => '模板相关素材，模板编辑器使用', + 'description' => '模板关联素材，普通模板编辑器使用', + 'type' => 'string', + 'required' => false, + 'example' => '{"video":["1805a0c6ca544fb395a06ca683619655"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + ], + 'Template' => [ + 'title' => '模板信息', + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板Id', + 'description' => '模板Id', + 'type' => 'string', + 'example' => '****01bf24bf41c78b2754cb3187****', + ], + 'Name' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => '模板名称', + ], + 'Type' => [ + 'title' => '模板类型', + 'description' => '模板类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + ], + 'example' => 'Timeline', + ], + 'Config' => [ + 'title' => '参见Timeline模板Config文档', + 'description' => '参见Timeline模板Config文档', + 'type' => 'string', + 'example' => '参见Config文档', + ], + 'CoverUrl' => [ + 'title' => '模板封面', + 'description' => '模板封面', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', + ], + 'PreviewMedia' => [ + 'title' => '预览视频媒资id', + 'description' => '预览视频媒资id', + 'type' => 'string', + 'example' => '****01bf24bf41c78b2754cb3187****', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'UploadFailed' => '上传失败', + 'ProcessFailed' => '高级模板分析失败', + 'Available' => '正常', + 'Uploading' => '上传中', + 'Created' => '已创建，还不能使用', + 'Processing' => '高级模板分析中', + ], + 'example' => 'Available', + ], + 'CreateSource' => [ + 'title' => '模板创建来源', + 'description' => '模板创建来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + 'ModifiedSource' => [ + 'title' => '模板修改来源', + 'description' => '模板修改来源', + 'type' => 'string', + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Name\\": \\"模板名称\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参见Config文档\\",\\n \\"CoverUrl\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"PreviewMedia\\": \\"****01bf24bf41c78b2754cb3187****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddTemplateResponse>\\n <RequestId>****2876-6263-4B75-8F2C-CD0F7FCF****</RequestId>\\n <Template>\\n <TemplateId>****01bf24bf41c78b2754cb3187****</TemplateId>\\n <Name>模板名称</Name>\\n <Type>Timeline</Type>\\n <Config>参见Config文档</Config>\\n <CoverUrl>http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg</CoverUrl>\\n <PreviewMedia>****01bf24bf41c78b2754cb3187****</PreviewMedia>\\n <Status>Normal</Status>\\n <CreateSource>OpenAPI</CreateSource>\\n <ModifiedSource>OpenAPI</ModifiedSource>\\n </Template>\\n</AddTemplateResponse>","errorExample":""}]', + 'title' => '创建模板', + 'description' => '### 使用说明'."\n" + ."\n" + .'- 使用普通模板，请参考：[普通模板快速入门](~~445399~~)'."\n" + .'- 使用高级模板，请参考：[高级模板创建及使用](~~445389~~)'."\n" + .'### 使用限制'."\n" + .'高级模板创建后有个解析的时间，状态为Processing，此时模板不可用，当模板状态为Available方可使用。模板解析时间与模板文件大小有关，一般10s-5min。', + ], + 'GetTemplate' => [ + 'summary' => '根据模板ID获取模板信息。高级模板有解析过长，当类型为高级模板时，Status为Available时即可使用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模板Id', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'RelatedMediaidFlag', + 'in' => 'query', + 'schema' => [ + 'title' => '是否返回模板关联素材，1返回，默认0，不返回', + 'description' => '相关媒体ID标记，默认值0，当值为1时返回模板关联素材，仅普通模板有效。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Template' => [ + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => '视频添加水印模板', + ], + 'Type' => [ + 'title' => '模板类型', + 'description' => '模板类型，目前支持：'."\n" + .'- Timeline: 普通模版'."\n" + .'- VETemplate: 高级模版'."\n" + .'- BatchEditing: 一键成片模版', + 'type' => 'string', + 'example' => 'Timeline', + ], + 'Config' => [ + 'title' => '模板配置', + 'description' => '模板配置'."\n" + .'- 普通模板配置，参考[Timeline模板配置详解](~~456193~~)'."\n" + .'- 高级模板配置，参考[创建高级模板](~~445389~~)'."\n" + .'- 一键成片模版配置，参考[一键成片模版配置参数说明](~~2878274~~)', + 'type' => 'string', + 'example' => '参考Timeline模板配置详解', + ], + 'PreviewMedia' => [ + 'title' => '预览素材', + 'description' => '预览素材', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态，取值范围'."\n" + .'- Available'."\n" + .'- Created'."\n" + .'- Uploading'."\n" + .'- Processing'."\n" + .'- UploadFailed'."\n" + .'- ProcessFailed', + 'type' => 'string', + 'example' => 'Available', + ], + 'CreateSource' => [ + 'title' => '创建来源', + 'description' => '创建来源，取值范围：'."\n" + .'- AliyunConsole '."\n" + .'- OpenAPI'."\n" + .'- WebSDK', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'ModifiedSource' => [ + 'title' => '修改来源', + 'description' => '修改来源，取值范围：'."\n" + .'- AliyunConsole '."\n" + .'- OpenAPI'."\n" + .'- WebSDK', + 'type' => 'string', + 'example' => 'OpenAPI', + ], + 'PreviewMediaStatus' => [ + 'title' => '预览素材状态', + 'description' => '预览素材状态'."\n" + .'- Init（初始状态：源文件未就绪）'."\n" + .'- Preparing（源文件准备中：比如上传中或者剪辑合成中）'."\n" + .'- PrepareFail（源文件准备失败：比如获取源文件信息失败）'."\n" + .'- Normal（正常：源文件已就绪）', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'ModifiedTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'CoverURL' => [ + 'title' => '封面URL', + 'description' => '封面URL', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', + ], + 'ClipsParam' => [ + 'title' => '提交合成任务的ClipsParam参数', + 'description' => '提交合成任务的ClipsParam参数模板，可把mediaId和text换成真实的参数来提交合成任务。使用方式参考：'."\n" + ."\n" + .'- [普通模版创建及使用](~~445399~~)'."\n" + .'- [高级模板创建及使用](~~445389~~)', + 'type' => 'string', + 'example' => '{"Media1":"mediaId","Text1":"text"}', + ], + 'RelatedMediaids' => [ + 'title' => '模板关联素材', + 'description' => '模板关联素材，普通模板编辑器使用', + 'type' => 'string', + 'example' => '{"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Template\\": {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"视频添加水印模板\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参考Timeline模板配置详解\\",\\n \\"PreviewMedia\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"PreviewMediaStatus\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\"}\\",\\n \\"RelatedMediaids\\": \\"{\\\\\\"video\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"],\\\\\\"audio\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"],\\\\\\"image\\\\\\":[\\\\\\"******c04f1d4a06996144cc1a******\\\\\\"]}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTemplateResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <Template>\\n <TemplateId>****20b48fb04483915d4f2cd8ac****</TemplateId>\\n <Name>视频添加水印模板</Name>\\n <Type>Timeline</Type>\\n <Config>参考Timeline模板配置详解</Config>\\n <PreviewMedia>****20b48fb04483915d4f2cd8ac****</PreviewMedia>\\n <Status>Available</Status>\\n <CreateSource>OpenAPI</CreateSource>\\n <ModifiedSource>OpenAPI</ModifiedSource>\\n <PreviewMediaStatus>Normal</PreviewMediaStatus>\\n <CreationTime>2020-12-26T04:11:10Z</CreationTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg</CoverURL>\\n </Template>\\n</GetTemplateResponse>","errorExample":""}]', + 'title' => '获取模板信息', + 'description' => '模板工厂是对剪辑合成时间线的一个封装，用户可以把常用的时间线定义成模板，当有同样的需求出现时，只需要传入关键参数及素材即可生产视频。'."\n" + .'- 使用普通模板，请参考：[普通模板快速入门](~~445399~~)'."\n" + .'- 使用高级模板，请参考：[高级模板创建及使用](~~445389~~)', + ], + 'UpdateTemplate' => [ + 'summary' => '调用UpdateTemplate接口修改云剪辑模板，支持修改模板标题、模板配置等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '云剪辑模板ID。可通过[智能媒体服务控制台](https://ice.console.aliyun.com/production/template/list/common)或[创建模板](~~441161~~)的返回参数中获取。', + 'type' => 'string', + 'required' => false, + 'example' => '23923ec3318f4c359e42e1e5b296****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '云剪辑模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '云剪辑模板1', + ], + ], + [ + 'name' => 'Config', + 'in' => 'formData', + 'schema' => [ + 'title' => '参见模板Config文档', + 'description' => '模板配置。详细说明请参见[普通模板Config详解](~~456193~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "VideoTracks": ['."\n" + .' {'."\n" + .' "VideoTrackClips": ['."\n" + .' {'."\n" + .' "Sys_Type" : "ArrayItems",'."\n" + .' "Sys_ArrayObject" : "$VideoArray",'."\n" + .' "Sys_Template" : {'."\n" + .' "MediaId" : "$MediaId"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'CoverUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '模板封面', + 'description' => '模板封面地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', + ], + ], + [ + 'name' => 'PreviewMedia', + 'in' => 'query', + 'schema' => [ + 'title' => '预览视频媒资id', + 'description' => '预览视频媒资ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1ae320b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '模板状态', + 'description' => '模板状态，取值范围：'."\n" + .'- Available：正常。'."\n" + .'- Created：已创建，还不能使用。'."\n" + .'- Uploading：上传中。'."\n" + .'- Processing：高级模板分析中。'."\n" + .'- UploadFailed：上传失败。'."\n" + .'- ProcessFailed：高级模板分析失败。'."\n" + ."\n" + .'> 高级模板创建后有解析时间，状态为Processing，此时模板不可用，当模板状态为Available方可使用。模板解析时间与模板文件大小有关，一般10s-5min。', + 'type' => 'string', + 'required' => false, + 'example' => 'Available', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '修改来源，默认OpenAPI', + 'description' => '修改来源，默认OpenAPI，取值范围：'."\n" + .'- AliyunConsole：通过阿里云控制台创建。'."\n" + .'- OpenAPI：通过OpenAPI创建。'."\n" + .'- WebSDK：通过WebSDK创建。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI', + ], + ], + [ + 'name' => 'RelatedMediaids', + 'in' => 'query', + 'schema' => [ + 'title' => '模板相关素材，模板编辑器使用', + 'description' => '模板关联素材，普通模板编辑器使用。', + 'type' => 'string', + 'required' => false, + 'example' => '{"video":["f64c6acc840247edb6b12f575c66****","9675dcf040ba4525bb037c29d156****"],"audio":["62a54019d9114009a5ae9bcfd70b****"],"image":["743ffbeb7e004c758cdc1fb34c04****"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8D475A5-F2EC-5755-ABD8-22D5561C****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F8D475A5-F2EC-5755-ABD8-22D5561C****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateTemplateResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n</UpdateTemplateResponse>","errorExample":""}]', + 'title' => '修改模板', + 'description' => '- 使用普通模板，请参考：[普通模板快速入门](https://help.aliyun.com/document_detail/270942.html)。'."\n" + .'- 使用高级模板，请参考：[高级模板创建及使用](https://help.aliyun.com/document_detail/291418.html)。', + ], + 'DeleteTemplate' => [ + 'summary' => '删除模板。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'schema' => [ + 'title' => '模板id，多个id用英文逗号隔开', + 'description' => '需要删除的模板ID，多个ID用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****,****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTemplateResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n</DeleteTemplateResponse>","errorExample":""}]', + 'title' => '删除模板', + 'description' => '模板工厂是对剪辑合成时间线的一个封装，用户可以把常用的时间线定义成模板，当有同样的需求出现时，只需要传入关键参数及素材即可生产视频。'."\n" + .'- 使用普通模板，请参考：[普通模板快速入门](https://help.aliyun.com/document_detail/270942.html)'."\n" + .'- 使用高级模板，请参考：[高级模板创建及使用](https://help.aliyun.com/document_detail/291418.html)', + ], + 'ListTemplates' => [ + 'summary' => '列出符合条件的模板，支持根据模板状态、创建来源等信息查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1。', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Timeline' => 'Timeline', + 'BatchEditing' => 'BatchEditing', + 'VETemplate' => 'VETemplate', + ], + 'example' => 'Timeline', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '模板状态', + 'description' => '模板状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UploadFailed' => '上传失败', + 'ProcessFailed' => '高级模板分析失败', + 'Available' => '正常', + 'Uploading' => '上传中', + 'Created' => '已创建，还不能使用', + 'Processing' => '高级模板分析中', + ], + 'example' => 'Available', + ], + ], + [ + 'name' => 'CreateSource', + 'in' => 'query', + 'schema' => [ + 'title' => '创建来源', + 'description' => '创建来源。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键词，可以根据模板id和title搜索', + 'description' => '搜索关键词，可以根据模板ID和title搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'title' => '排序参数，默认根据创建时间倒序', + 'description' => '排序参数，默认根据创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreationTime:ASC' => '按照创建时间正序', + 'CreationTime:Desc' => '按照创建时间倒序', + ], + 'example' => 'CreationTime:Desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量。', + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Templates' => [ + 'description' => '模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板信息。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '模板ID', + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => '云剪辑模板', + ], + 'Type' => [ + 'title' => '模板类型', + 'description' => '模板类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + ], + 'example' => 'Timeline', + ], + 'Config' => [ + 'title' => '模板配置', + 'description' => '模板配置。', + 'type' => 'string', + 'example' => '参考Timeline模板配置详解', + ], + 'PreviewMedia' => [ + 'title' => '预览素材', + 'description' => '预览素材。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Status' => [ + 'title' => '模板状态', + 'description' => '模板状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UploadFailed' => '上传失败', + 'ProcessFailed' => '高级模板分析失败', + 'Available' => '正常', + 'Uploading' => '上传中', + 'Created' => '已创建，还不能使用', + 'Processing' => '高级模板分析中', + ], + 'example' => 'Available', + ], + 'CreateSource' => [ + 'title' => '创建来源', + 'description' => '创建来源。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + 'ModifiedSource' => [ + 'title' => '修改来源', + 'description' => '修改来源。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + 'PreviewMediaStatus' => [ + 'title' => '预览素材状态', + 'description' => '预览素材状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'PrepareFail' => '媒资分析失败', + 'Init' => '媒资初始化状态', + 'Normal' => '媒资正常', + 'Preparing' => '媒资分析中', + ], + 'example' => 'Normal', + ], + 'CreationTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'ModifiedTime' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'CoverURL' => [ + 'title' => '封面URL', + 'description' => '封面URL。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg', + ], + 'ClipsParam' => [ + 'title' => 'ClipsParam', + 'description' => '剪辑参数。', + 'type' => 'string', + 'example' => '{"Media1":"mediaId","Text1":"text"}', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TotalCount\\": 100,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"云剪辑模板\\",\\n \\"Type\\": \\"Timeline\\",\\n \\"Config\\": \\"参考Timeline模板配置详解\\",\\n \\"PreviewMedia\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Status\\": \\"Available\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"OpenAPI\\",\\n \\"PreviewMediaStatus\\": \\"Normal\\",\\n \\"CreationTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg\\",\\n \\"ClipsParam\\": \\"{\\\\\\"Media1\\\\\\":\\\\\\"mediaId\\\\\\",\\\\\\"Text1\\\\\\":\\\\\\"text\\\\\\"}\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTemplatesResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <TotalCount>100</TotalCount>\\n <Templates>\\n <TemplateId>****20b48fb04483915d4f2cd8ac****</TemplateId>\\n <Name>视频添加水印模板</Name>\\n <Type>Timeline</Type>\\n <Config>参考Timeline模板配置详解</Config>\\n <PreviewMedia>****20b48fb04483915d4f2cd8ac****</PreviewMedia>\\n <Status>Available</Status>\\n <CreateSource>OpenAPI</CreateSource>\\n <ModifiedSource>OpenAPI</ModifiedSource>\\n <PreviewMediaStatus>Normal</PreviewMediaStatus>\\n <CreationTime>2020-12-26T04:11:10Z</CreationTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg</CoverURL>\\n </Templates>\\n</ListTemplatesResponse>","errorExample":""}]', + 'title' => '列出符合条件的模板', + 'description' => '模板工厂是对剪辑合成时间线的一个封装，用户可以把常用的时间线定义成模板，当有同样的需求出现时，只需要传入关键参数及素材即可生产视频。'."\n" + .'- 使用普通模板，请参考：[普通模板快速入门](https://help.aliyun.com/document_detail/270942.html)'."\n" + .'- 使用高级模板，请参考：[高级模板创建及使用](https://help.aliyun.com/document_detail/291418.html)', + ], + 'GetTemplateMaterials' => [ + 'summary' => '返回高级模板包中的素材地址，供高级模板编辑器使用，素材链接30分钟过期。FileList为所需素材数组，不填则默认返回全部素材地址，最多返回400个。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板Id', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'FileList', + 'in' => 'query', + 'schema' => [ + 'title' => '所需文件列表', + 'description' => '所需文件列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["music.mp3","config.json","assets/1.jpg"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MaterialUrls' => [ + 'title' => '关联素材地址', + 'description' => '关联素材地址。', + 'type' => 'string', + 'example' => '{"music.mp3":"https://bucket.oss-cn-shanghai.aliyuncs.com/music.mp3?sign=xxx","config.json":"https://bucket.oss-cn-shanghai.aliyuncs.com/config.json?sign=xxx","assets/1.jpg":"https://bucket.oss-cn-shanghai.aliyuncs.com/assets/1.jpg?sign=xxx"}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MaterialUrls\\": \\"{\\\\\\"music.mp3\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/music.mp3?sign=xxx\\\\\\",\\\\\\"config.json\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/config.json?sign=xxx\\\\\\",\\\\\\"assets/1.jpg\\\\\\":\\\\\\"https://bucket.oss-cn-shanghai.aliyuncs.com/assets/1.jpg?sign=xxx\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTemplateMaterialsResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <MaterialUrls>{\\"music.mp3\\":\\"https://bucket.oss-cn-shanghai.aliyuncs.com/music.mp3?sign=xxx\\",\\"config.json\\":\\"https://bucket.oss-cn-shanghai.aliyuncs.com/config.json?sign=xxx\\",\\"assets/1.jpg\\":\\"https://bucket.oss-cn-shanghai.aliyuncs.com/assets/1.jpg?sign=xxx\\"}</MaterialUrls>\\n</GetTemplateMaterialsResponse>","errorExample":""}]', + 'title' => '获取模板素材地址', + ], + 'GetTemplateParams' => [ + 'summary' => '获取模板可替换素材参数信息，包括参数名称、素材默认值、素材封面。当前仅支持高级模板。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceDXIJ4D', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + ], + 'TemplateId' => [ + 'description' => '模板Id', + 'type' => 'string', + 'example' => '******419c8741c1b4325f035b******', + ], + 'ParamList' => [ + 'description' => '参数列表', + 'type' => 'array', + 'items' => [ + 'description' => '模板参数', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '模板ID', + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'video1', + ], + 'Type' => [ + 'description' => '素材类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Video' => '视频', + 'Text' => '字幕', + 'Image' => '图片', + ], + 'example' => 'Image', + ], + 'CoverUrl' => [ + 'description' => '原始素材封面', + 'type' => 'string', + 'example' => 'https://ice-materials-***.alicdn.com/***/********20221****.jpg', + ], + 'MediaUrl' => [ + 'description' => '原始素材地址', + 'type' => 'string', + 'example' => 'https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4', + ], + 'Content' => [ + 'description' => '原始字幕内容', + 'type' => 'string', + 'example' => '字幕测试', + ], + 'X' => [ + 'description' => '原始素材相对于视频左上角的横向距离，绝对像素值。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Y' => [ + 'description' => '原始素材相对于视频左上角的纵向距离，绝对像素值。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Width' => [ + 'description' => '原始素材在输出视频中的宽度，绝对像素值。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Height' => [ + 'description' => '原始素材在输出视频中的高度，绝对像素值。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'TimelineIn' => [ + 'description' => '原始素材片段相对于时间线的入点，单位：秒。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '5.5', + ], + 'TimelineOut' => [ + 'description' => '原始素材片段相对于时间线的出点，单位：秒。当前仅控制台创建的普通模板会返回此值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8.5', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"TemplateId\\": \\"******419c8741c1b4325f035b******\\",\\n \\"ParamList\\": [\\n {\\n \\"Key\\": \\"video1\\",\\n \\"Type\\": \\"Image\\",\\n \\"CoverUrl\\": \\"https://ice-materials-***.alicdn.com/***/********20221****.jpg\\",\\n \\"MediaUrl\\": \\"https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4\\",\\n \\"Content\\": \\"字幕测试\\",\\n \\"X\\": 100,\\n \\"Y\\": 100,\\n \\"Width\\": 300,\\n \\"Height\\": 300,\\n \\"TimelineIn\\": 5.5,\\n \\"TimelineOut\\": 8.5\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取模板参数信息', + ], + 'DeleteHotwordLibrary' => [ + 'summary' => '根据提供的热词库ID删除指定的热词库。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'HotwordLibraryId', + 'in' => 'query', + 'schema' => [ + 'title' => '删除热词库Id', + 'description' => '删除热词库Id', + 'type' => 'string', + 'required' => false, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****83B7-7F87-4792-BFE9-63CD2137****', + ], + 'Success' => [ + 'title' => '删除是否成功', + 'description' => '删除是否成功', + 'type' => 'boolean', + 'default' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****83B7-7F87-4792-BFE9-63CD2137****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除热词库', + 'description' => '## 请求说明'."\n" + .'- 该接口用于删除用户创建的热词库。'."\n" + .'- 删除操作不可逆，请谨慎使用。'."\n" + .'- 每个账号下最多可以创建100个热词库，删除后可释放空间以创建新的热词库。', + ], + 'GetHotwordLibrary' => [ + 'summary' => '查询热词词库。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'HotwordLibraryId', + 'in' => 'query', + 'schema' => [ + 'title' => '热词库Id', + 'description' => '热词库Id', + 'type' => 'string', + 'required' => true, + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****12e8864746a0a398****', + ], + 'HotwordLibraryId' => [ + 'title' => '热词库Id', + 'description' => '热词库Id', + 'type' => 'string', + 'example' => '****05512043f49f697f7425****', + ], + 'Name' => [ + 'title' => '热词库名称', + 'description' => '热词库名称', + 'type' => 'string', + 'example' => '热词库名称', + ], + 'Description' => [ + 'title' => '热词库描述', + 'description' => '热词库描述', + 'type' => 'string', + 'example' => '热词库描述', + ], + 'Hotwords' => [ + 'title' => '热词列表', + 'description' => '热词列表', + 'type' => 'array', + 'items' => [ + 'description' => '热词数据', + '$ref' => '#/components/schemas/Hotword', + ], + ], + 'UsageScenario' => [ + 'title' => '热词库使用场景', + 'description' => '热词库使用场景', + 'type' => 'string', + 'example' => 'ASR', + ], + 'CreationTime' => [ + 'title' => '热词库创建时间', + 'description' => '热词库创建时间', + 'type' => 'string', + 'example' => '2020-12-23T13:33:49Z', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****12e8864746a0a398****\\",\\n \\"HotwordLibraryId\\": \\"****05512043f49f697f7425****\\",\\n \\"Name\\": \\"热词库名称\\",\\n \\"Description\\": \\"热词库描述\\",\\n \\"Hotwords\\": [\\n {\\n \\"TranspositionResultList\\": [\\n {\\n \\"TranslatedText\\": \\"你好\\",\\n \\"TargetLanguage\\": \\"zh\\"\\n }\\n ],\\n \\"Language\\": \\"en\\",\\n \\"Text\\": \\"hello\\",\\n \\"Weight\\": 0\\n }\\n ],\\n \\"UsageScenario\\": \\"ASR\\",\\n \\"CreationTime\\": \\"2020-12-23T13:33:49Z\\"\\n}","type":"json"}]', + 'title' => '查询热词词库', + 'description' => '## 请求说明'."\n" + .'通过提供词库ID，可以获取到该词库的详细信息，包括但不限于词库名称、描述以及包含的所有热词及其属性。此接口主要用于管理和查看已创建的热词库的具体内容。'."\n", + ], + 'ListHotwordLibraries' => [ + 'summary' => '获取指定条件下的所有热词库信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当前开始读取的位置', + 'description' => '当前开始读取的位置', + 'type' => 'string', + 'required' => false, + 'example' => '****73f33c91-d59383e8280b****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1。', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序参数，默认根据创建时间倒序', + 'description' => '排序参数，默认根据创建时间倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '热词库名称', + 'type' => 'string', + 'required' => false, + 'example' => '热词库使用名称', + ], + ], + [ + 'name' => 'UsageScenario', + 'in' => 'query', + 'schema' => [ + 'title' => '词库的使用场景'."\n" + .'● ASR智能文本识别：ASR'."\n" + .'● 结构化媒资：StructuredMediaAssets'."\n" + .'● 视频翻译：VideoTranslation', + 'description' => '词库的使用场景：'."\n" + ."\n" + .'- ASR智能文本识别：ASR'."\n" + .'- 结构化媒资：StructuredMediaAssets'."\n" + .'- 视频翻译：VideoTranslation 词库一旦新增后，该字段不可修改', + 'type' => 'string', + 'required' => false, + 'example' => 'ASR', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选开始时间', + 'description' => '筛选开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-26T04:11:10Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选结束时间', + 'description' => '筛选结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2020-12-26T04:11:10Z', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'example' => 'CBB6BC61D08', + ], + 'MaxResults' => [ + 'description' => '返回热词库信息的最大数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '热词库总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'HotwordLibraryList' => [ + 'description' => '热词库列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '描述，长度上限200', + 'type' => 'string', + 'example' => '存放名人的词库', + ], + 'UsageScenario' => [ + 'description' => '词库的使用场景：'."\n" + .'- ASR智能文本识别：ASR'."\n" + .'- 结构化媒资：StructuredMediaAssets'."\n" + .'- 视频翻译：VideoTranslation'."\n" + .'词库一旦新增后，该字段不可修改', + 'type' => 'string', + 'example' => 'ASR', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z'."\n", + ], + 'CreationTime' => [ + 'description' => '创建时间'."\n", + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'HotwordLibraryId' => [ + 'description' => '词库 ID。'."\n", + 'type' => 'string', + 'example' => 'a93b91141c0f422fa114af203f8b****', + ], + 'Name' => [ + 'description' => '词库名称。'."\n", + 'type' => 'string', + 'example' => 'my_hotwords', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 20,\\n \\"HotwordLibraryList\\": [\\n {\\n \\"Description\\": \\"存放名人的词库\\",\\n \\"UsageScenario\\": \\"ASR\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\\\n\\",\\n \\"CreationTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"HotwordLibraryId\\": \\"a93b91141c0f422fa114af203f8b****\\",\\n \\"Name\\": \\"my_hotwords\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询所有热词库列表', + 'description' => '## 请求说明'."\n" + .'- 该接口用于查询用户创建的所有热词库的列表。'."\n" + .'- 可以通过 `Name` 参数进行模糊搜索，支持分页和时间范围筛选。'."\n" + .'- 默认按创建时间倒序排列，可以通过 `SortBy` 参数调整排序方式。'."\n" + .'- 每次请求返回的最大记录条数为100，默认值为10。'."\n" + .'- 使用 `NextToken` 参数可以实现分页读取数据。', + ], + 'UpdateHotwordLibrary' => [ + 'summary' => '用于更新指定热词库的信息，包括名称、描述和热词列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '词库名称，长度上限100', + 'description' => '词库名称，长度上限100', + 'type' => 'string', + 'required' => false, + 'example' => 'my_hotwords', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述，长度上限200', + 'description' => '描述，长度上限200', + 'type' => 'string', + 'required' => false, + 'example' => '存放名人的词库', + ], + ], + [ + 'name' => 'Hotwords', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '热词列表，长度上限300', + 'description' => '热词列表，长度上限300', + 'type' => 'array', + 'items' => [ + 'title' => '热词信息', + 'description' => '热词信息', + 'required' => false, + '$ref' => '#/components/schemas/Hotword', + ], + 'required' => false, + 'example' => '存放名人的词库', + ], + ], + [ + 'name' => 'HotwordLibraryId', + 'in' => 'query', + 'schema' => [ + 'description' => '词库ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '*a0052ff71efbfd4e7e6c66*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID'."\n", + 'type' => 'string', + 'example' => '*3B-0E1A-586A-AC29-742247*', + ], + 'Success' => [ + 'title' => '热词库Id', + 'description' => '热词库Id', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*3B-0E1A-586A-AC29-742247*\\",\\n \\"Success\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', + 'title' => '修改热词库', + 'description' => '## 请求说明'."\n" + .'- 该接口允许用户修改已存在的热词库信息。'."\n" + .'- 修改时需要提供热词库ID（`HotwordLibraryId`），这是必填参数。'."\n" + .'- 可以同时更新热词库的名称（`Name`）、描述（`Description`）以及热词列表（`HotWords`）。'."\n" + .'- 热词列表中的每个热词可以设置其文本内容（`Text`）、权重（`Weight`）、语种（`Language`）及翻译转置结果（`TranspositionResultList`）。'."\n" + .'- 注意：单个账号下最多创建100个词库，单个词库最多添加300个热词；在单个词库内，一个热词的`language`和`text`组合起来必须唯一；在单个词库内，一个热词的`TranspositionResultList`里面的`TranslatedText`和`TargetLanguage`组合也必须唯一。', + ], + 'CreateHotwordLibrary' => [ + 'summary' => '创建热词库。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '词库名称，长度上限100', + 'description' => '词库名称，长度上限100', + 'type' => 'string', + 'required' => true, + 'example' => 'my_hotwords', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述，长度上限200', + 'description' => '描述，长度上限200', + 'type' => 'string', + 'required' => false, + 'example' => '存放名人的词库', + ], + ], + [ + 'name' => 'UsageScenario', + 'in' => 'query', + 'schema' => [ + 'title' => '词库的使用场景'."\n" + .'● ASR智能文本识别：ASR'."\n" + .'● 结构化媒资：StructuredMediaAssets'."\n" + .'● 视频翻译：VideoTranslation'."\n" + .'词库一旦新增后，该字段不可修改', + 'description' => '词库的使用场景'."\n" + ."\n" + .'● ASR智能文本识别：ASR'."\n" + ."\n" + .'● 结构化媒资：StructuredMediaAssets'."\n" + ."\n" + .'● 视频翻译：VideoTranslation'."\n" + ."\n" + .'词库一旦新增后，该字段不可修改', + 'type' => 'string', + 'required' => true, + 'example' => 'ASR', + ], + ], + [ + 'name' => 'Hotwords', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '热词列表，长度上限300', + 'description' => '热词列表，长度上限300', + 'type' => 'array', + 'items' => [ + 'title' => '热词信息', + 'description' => '热词信息', + 'required' => false, + '$ref' => '#/components/schemas/Hotword', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '13cbb83e-043c-4728-ac35-*****', + ], + 'HotwordLibraryId' => [ + 'title' => '热词库Id', + 'description' => '热词库Id', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\",\\n \\"HotwordLibraryId\\": \\"****96e8864746a0b6f3****\\"\\n}","type":"json"}]', + 'title' => '创建热词库', + 'description' => '调用CreateHotwordLibrary接口创建热词库。', + ], + 'CreateAvatarTrainingJob' => [ + 'summary' => '本接口用于创建数字人训练任务，配置数字人基础信息与训练所需要的素材信息等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AvatarName', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人名称，不多于 7 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '小数', + 'maxLength' => 7, + ], + ], + [ + 'name' => 'AvatarDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人描述，不多于 1000 个字。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个数字人，用于某某场景。', + 'maxLength' => 1027, + ], + ], + [ + 'name' => 'AvatarType', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人类型', + 'type' => 'string', + 'required' => false, + 'example' => '2DAvatar', + ], + ], + [ + 'name' => 'Thumbnail', + 'in' => 'query', + 'schema' => [ + 'description' => '缩略图 URL'."\n" + .'- 训练成功后会将缩略图上传到这个地址中'."\n" + .'- 必须是用户下合法的 OSS 公网 URL'."\n" + .'- 不多于 512 个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'Portrait', + 'in' => 'query', + 'schema' => [ + 'description' => '- 头像图片的媒资 Id，长度为 32 个字符'."\n" + .'- 如果后续调用 SubmitAvatarTrainingJob 提交训练，则本字段为必填'."\n" + .'- 图片素材要求宽高相同', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****', + 'maxLength' => 32, + 'minLength' => 32, + ], + ], + [ + 'name' => 'Video', + 'in' => 'query', + 'schema' => [ + 'description' => '训练视频媒资 ID'."\n" + .'- 长度为 32 个字符'."\n" + .'- 支持 mp4，mov，webm 格式'."\n" + .'- 素材时长需在 5 分钟到 15 分钟内'."\n" + .'- 素材分辨率需为 1920 * 1080 或 1080 * 1920'."\n" + .'- 如果后续调用 SubmitAvatarTrainingJob 提交训练，则本字段为必填', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****', + 'maxLength' => 32, + 'minLength' => 32, + ], + ], + [ + 'name' => 'Transparent', + 'in' => 'query', + 'schema' => [ + 'description' => '训练视频是否支持透明通道'."\n" + .'><notice>请严格确认当前设置与提交训练视频情况一致，否则合成数字人可能会异常></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人训练任务 Id', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建和初始化数字人训练任务', + 'description' => '本接口仅用于初始化训练任务相关信息，并不会提交训练，正式提交训练需调用 [SubmitAvatarTrainingJob](~~2526196~~) 接口。', + ], + 'UpdateAvatarTrainingJob' => [ + 'summary' => '调用此接口能够修改数字人训练任务的信息，包括：'."\n" + .'1. 修改基本信息；'."\n" + .'2. 在训练失败后，更新 Video、Transparent 等信息后重新进行训练。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'required' => true, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + [ + 'name' => 'AvatarName', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人名称，不多于 7 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '小数', + 'maxLength' => 7, + ], + ], + [ + 'name' => 'AvatarDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人描述。不多于 1000 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个数字人，用于某某场景。', + 'maxLength' => 1024, + ], + ], + [ + 'name' => 'Thumbnail', + 'in' => 'query', + 'schema' => [ + 'description' => '缩略图 URL'."\n" + .'- 训练成功后会将缩略图上传到本地址中'."\n" + .'- 必须是用户下合法的 OSS 公网 URL'."\n" + .'- 不多于 512 个字符'."\n" + .'- 训练成功后不允许更新', + 'type' => 'string', + 'required' => false, + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'Portrait', + 'in' => 'query', + 'schema' => [ + 'description' => '头像图片媒资 ID，长度为 32 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****', + 'maxLength' => 32, + 'minLength' => 32, + ], + ], + [ + 'name' => 'Video', + 'in' => 'query', + 'schema' => [ + 'description' => '训练视频媒资 ID'."\n" + .'- 长度为 32 个字符'."\n" + .'- 支持 mp4，mov，webm 格式'."\n" + .'- 素材时长需在 5 分钟到 15 分钟内'."\n" + .'- 素材分辨率需为 1920 * 1080 或 1080 * 1920', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****', + 'maxLength' => 32, + 'minLength' => 32, + ], + ], + [ + 'name' => 'Transparent', + 'in' => 'query', + 'schema' => [ + 'description' => '用于标识传入的视频是否支持透明通道。'."\n" + ."\n" + .'仅允许处于「初始化」或「训练失败」状态下的任务修改本字段'."\n" + .'><notice>请严格确认当前设置与提交训练视频情况一致，否则合成数字人可能会异常></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '表示是否调用成功：'."\n" + .'- true：调用成功'."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => '更新数字人训练任务信息', + ], + 'SubmitAvatarTrainingJob' => [ + 'summary' => '调用此接口来正式提交数字人训练任务：'."\n" + .'1. 首次提交训练；'."\n" + .'2. 在训练失败后重新提交训练。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人任务 ID', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人任务 ID', + 'type' => 'string', + 'example' => '****29faef8144638ba42eb8e037****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', + 'title' => '提交数字人训练任务', + ], + 'GetAvatarTrainingJob' => [ + 'summary' => '本接口用于查询单个数字人任务的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Data' => [ + 'description' => '调用成功时返回的数据', + 'type' => 'object', + 'properties' => [ + 'AvatarTrainingJob' => [ + 'description' => '数字人训练任务', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人任务 ID', + 'type' => 'string', + 'example' => '****55d86f7f4587943ce7734d6b****', + ], + 'AvatarId' => [ + 'description' => '数字人 ID', + 'type' => 'string', + 'example' => 'Avatar-XXXX', + ], + 'AvatarName' => [ + 'description' => '数字人名称', + 'type' => 'string', + 'example' => '小数', + ], + 'AvatarDescription' => [ + 'description' => '数字人描述', + 'type' => 'string', + 'example' => '这是一个数字人，用于某某场景。', + ], + 'AvatarType' => [ + 'description' => '数字人类型', + 'type' => 'string', + 'example' => '2DAvatar', + ], + 'Status' => [ + 'description' => '数字人训练任务状态。'."\n" + .'取值范围：'."\n" + ."\n" + .'- Init（初始化、草稿）'."\n" + ."\n" + .'- Queuing（排队中）'."\n" + ."\n" + .'- Training（训练中）'."\n" + ."\n" + .'- Success（训练成功）'."\n" + ."\n" + .'- Fail（训练失败）', + 'type' => 'string', + 'example' => 'Success'."\n", + ], + 'Message' => [ + 'description' => '状态描述信息', + 'type' => 'string', + 'example' => '训练成功', + ], + 'Thumbnail' => [ + 'description' => '缩略图 URL', + 'type' => 'string', + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', + ], + 'Portrait' => [ + 'description' => '头像图片媒资 ID', + 'type' => 'string', + 'example' => '****571c704445f9a0ee011406c2****', + ], + 'Video' => [ + 'description' => '训练视频媒资 ID', + 'type' => 'string', + 'example' => '****571c704445f9a0ee011406c2****', + ], + 'Transparent' => [ + 'description' => '用于标识传入的视频是否支持透明通道', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FirstTrainingTime' => [ + 'description' => '- 首次发起训练时间'."\n" + .'- 格式为 utc 时间', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + 'LastTrainingTime' => [ + 'description' => '- 最近一次训练时间'."\n" + .'- 格式为 utc 时间', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '请求是否调用成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"AvatarTrainingJob\\": {\\n \\"JobId\\": \\"****55d86f7f4587943ce7734d6b****\\",\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"Message\\": \\"训练成功\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Video\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true,\\n \\"FirstTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"LastTrainingTime\\": \\"2020-12-23T13:33:40Z\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询数字人训练任务的详细信息', + ], + 'DeleteAvatarTrainingJob' => [ + 'summary' => '调用本接口可以删除处于「初始化（草稿）」、「训练失败」状态下的任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => '删除数字人训练任务', + ], + 'ListAvatarTrainingJobs' => [ + 'summary' => '调用本接口可以查询您名下的数字人训练任务信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '分页页码，默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页面大小。'."\n" + .'- 默认值：10'."\n" + .'- 最大值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值范围：'."\n" + ."\n" + .'- Init（初始化、草稿）'."\n" + ."\n" + .'- Queuing（排队中）'."\n" + ."\n" + .'- Training（训练中）'."\n" + ."\n" + .'- Success（训练成功）'."\n" + ."\n" + .'- Fail（训练失败）', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'AvatarTrainingJobList' => [ + 'description' => '数字人训练任务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '数字人训练任务 ID', + 'type' => 'string', + 'example' => '*****aded114489ea02e0addf93*****', + ], + 'AvatarId' => [ + 'description' => '数字人 ID', + 'type' => 'string', + 'example' => 'Avatar-XXX', + ], + 'AvatarName' => [ + 'description' => '数字人名称', + 'type' => 'string', + 'example' => '小数', + ], + 'AvatarDescription' => [ + 'description' => '数字人描述', + 'type' => 'string', + 'example' => '这是一个数字人，用于某某场景。', + ], + 'AvatarType' => [ + 'description' => '数字人类型', + 'type' => 'string', + 'example' => '2DAvatar', + ], + 'Status' => [ + 'description' => '数字人训练任务状态', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '状态描述信息', + 'type' => 'string', + 'example' => '训练成功', + ], + 'Portrait' => [ + 'description' => '头像图片媒资 ID', + 'type' => 'string', + 'example' => '*****aded114489ea02e0addf93*****', + ], + 'FirstTrainingTime' => [ + 'description' => '首次发起训练时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + 'LastTrainingTime' => [ + 'description' => '最近一次训练时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，格式为utc时间。', + 'type' => 'string', + 'example' => '2020-12-23T13:33:40Z', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + .'- true：成功'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"AvatarTrainingJobList\\": [\\n {\\n \\"JobId\\": \\"*****aded114489ea02e0addf93*****\\",\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"训练成功\\",\\n \\"Portrait\\": \\"*****aded114489ea02e0addf93*****\\",\\n \\"FirstTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"LastTrainingTime\\": \\"2020-12-23T13:33:40Z\\",\\n \\"CreateTime\\": \\"2020-12-23T13:33:40Z\\"\\n }\\n ],\\n \\"TotalCount\\": 3\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询数字人训练任务列表', + ], + 'GetAvatar' => [ + 'summary' => '调用本接口，可以查询某个已经训练成功的数字人的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AvatarId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 数字人 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'Avatar-XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'Avatar' => [ + 'description' => '数字人', + 'type' => 'object', + 'properties' => [ + 'AvatarId' => [ + 'description' => '数字人 ID', + 'type' => 'string', + 'example' => 'Avatar-XXXX', + ], + 'AvatarName' => [ + 'description' => '数字人名称', + 'type' => 'string', + 'example' => '小数', + ], + 'AvatarDescription' => [ + 'description' => '数字人描述', + 'type' => 'string', + 'example' => '这是一个数字人，用于某某场景。', + ], + 'AvatarType' => [ + 'description' => '数字人类型', + 'type' => 'string', + 'example' => '2DAvatar', + ], + 'Thumbnail' => [ + 'description' => '缩略图 URL', + 'type' => 'string', + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', + ], + 'Portrait' => [ + 'description' => '头像图片媒资 ID', + 'type' => 'string', + 'example' => '****571c704445f9a0ee011406c2****', + ], + 'Transparent' => [ + 'description' => '用于标识当前数字人是否支持透明通道', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Width' => [ + 'description' => '数字人形象的宽（单位：像素）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'Height' => [ + 'description' => '数字人形象的高（单位：像素）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"Avatar\\": {\\n \\"AvatarId\\": \\"Avatar-XXXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true,\\n \\"Width\\": 1080,\\n \\"Height\\": 1920\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => ' 查询数字人', + ], + 'ListAvatars' => [ + 'summary' => '调用本接口，可以查询到您名下所有已经训练成功的数字人信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '- 分页页码'."\n" + .'- 默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '- 分页页面大小'."\n" + .'- 默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AvatarType', + 'in' => 'query', + 'schema' => [ + 'description' => '- 数字人类型'."\n" + .'- 2DAvatar', + 'type' => 'string', + 'required' => false, + 'example' => '2DAvatar', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'AvatarList' => [ + 'description' => '数字人列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AvatarId' => [ + 'description' => '数字人 ID', + 'type' => 'string', + 'example' => 'Avatar-XXX', + ], + 'AvatarName' => [ + 'description' => '数字人名称', + 'type' => 'string', + 'example' => '小数', + ], + 'AvatarDescription' => [ + 'description' => '数字人描述', + 'type' => 'string', + 'example' => '这是一个数字人，用于某某场景。', + ], + 'AvatarType' => [ + 'description' => '数字人类型', + 'type' => 'string', + 'example' => '2DAvatar', + ], + 'Thumbnail' => [ + 'description' => '缩略图 URL', + 'type' => 'string', + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png', + ], + 'Portrait' => [ + 'description' => '头像图片媒资 ID', + 'type' => 'string', + 'example' => '****571c704445f9a0ee011406c2****', + ], + 'Transparent' => [ + 'description' => '当前数字人形象是否支持透明通道', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + .'- true：成功'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"AvatarList\\": [\\n {\\n \\"AvatarId\\": \\"Avatar-XXX\\",\\n \\"AvatarName\\": \\"小数\\",\\n \\"AvatarDescription\\": \\"这是一个数字人，用于某某场景。\\",\\n \\"AvatarType\\": \\"2DAvatar\\",\\n \\"Thumbnail\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/thumbnail.png\\",\\n \\"Portrait\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"Transparent\\": true\\n }\\n ],\\n \\"TotalCount\\": 1\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询数字人列表', + ], + 'CreateCustomizedVoiceJob' => [ + 'summary' => '创建人声克隆任务，用于初始化配置人声克隆任务的基础信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义的声音 Id （声音的英文或拼音）'."\n" + ."\n" + .'- 不能和您其他的定制声音 Id 重名'."\n" + .'- 不超过 32 个字符'."\n" + .'- 仅支持字母和数字', + 'type' => 'string', + 'required' => true, + 'example' => 'xiaozhuan', + 'maxLength' => 32, + 'minLength' => 0, + ], + ], + [ + 'name' => 'VoiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '声音名字（一般为中文名）'."\n" + .'- 不超过 32 个字符', + 'type' => 'string', + 'required' => false, + 'example' => '小专', + 'maxLength' => 32, + 'minLength' => 0, + ], + ], + [ + 'name' => 'VoiceDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '声音描述'."\n" + .'- 不超过 256 个字符', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个个性化声音', + 'maxLength' => 256, + 'minLength' => 0, + ], + ], + [ + 'name' => 'Gender', + 'in' => 'query', + 'schema' => [ + 'description' => '性别，取值范围：'."\n" + .'- female：女性'."\n" + .'- male：男性', + 'type' => 'string', + 'required' => true, + 'example' => 'female', + 'enum' => [ + 'female', + 'male', + ], + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '场景，取值范围：'."\n" + .'- story：故事'."\n" + .'- interaction：交互'."\n" + .'- navigation：导航', + 'type' => 'string', + 'required' => true, + 'example' => 'story', + 'enum' => [ + 'story', + 'interaction', + 'navigation', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '表示是否调用成功。'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'VoiceId' => [ + 'description' => '声音 Id', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + 'JobId' => [ + 'description' => '人声克隆任务 Id', + 'type' => 'string', + 'example' => '****29faef8144638ba42eb8e037****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"JobId\\": \\"****29faef8144638ba42eb8e037****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建人声克隆任务（基础版）', + 'description' => '<props="china">- 人声克隆计费项分为定制和使用两个维度，详情请参见[人声克隆计费](~~2399891#section-gy3-80e-clt~~)。</props>'."\n" + ."\n\n" + .'- 若您要实现娱乐级别效果，可以调用本接口，使用时，您需要录制固定20剧文本，系统会提取关键声纹特征，即可快速低成本的进行人声克隆定制。', + ], + 'GetDemonstrationForCustomizedVoiceJob' => [ + 'summary' => '通过本接口来获取训练个性化人声所需要朗读的文本及示例音频。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '示范场景。'."\n" + ."\n" + .'可以取以下的一个值：'."\n" + ."\n" + .'- **story**：故事'."\n" + .'- **interaction**：交互'."\n" + .'- **navigation**：导航', + 'type' => 'string', + 'required' => true, + 'example' => 'story', + 'enum' => [ + 'story', + 'interaction', + 'navigation', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '操作是否成功，取值：'."\n" + .'- true：成功'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'DemonstrationList' => [ + 'description' => '示范列表，返回 20 条需要朗读的文本及对应语音示例', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DemoAudio' => [ + 'description' => '示例音频 URL'."\n" + .'- OSS 地址'."\n" + .'><notice>音频文件过期时间为 12 小时></notice>', + 'type' => 'string', + 'example' => 'http://bucket.oss-cn-shanghai.aliyuncs.com/1.wav', + ], + 'Text' => [ + 'description' => '需要朗读的文本内容', + 'type' => 'string', + 'example' => '不行，他想了一下，我不能这样对国王说，这是在撒谎。', + ], + 'AudioId' => [ + 'description' => '该文本的序号，对应音频检测时需要传入的 AduioRecordId 字段', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DemonstrationList\\": [\\n {\\n \\"DemoAudio\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/1.wav\\",\\n \\"Text\\": \\"不行，他想了一下，我不能这样对国王说，这是在撒谎。\\",\\n \\"AudioId\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取需要朗读的示范文本及音频（基础版）', + ], + 'DetectAudioForCustomizedVoiceJob' => [ + 'summary' => '本接口用来检测用户的朗读是否有明显的发音错误、嘈杂的环境等。'."\n" + .'云端在进行完音频检测后，对于检测合格的音频会暂存在云端，供后续训练声音时使用，请勿省略该步骤。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声 Id', + 'type' => 'string', + 'required' => true, + 'example' => 'xiaozhuan', + ], + ], + [ + 'name' => 'RecordUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '录音文件 URL 地址'."\n" + .'><notice>必须是您账号下的 OSS 地址，并且 OSS Bucket 的所在区域要与调用本接口时服务所在的区域相同></notice>'."\n" + .'><notice>音频格式要求：音频文件必须是 wav 或 pcm 格式，且为单声道（mono）16 bit 采样位数音频。音频采样率为 48000 Hz></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/record1.wav', + ], + ], + [ + 'name' => 'AudioRecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'RecordUrl 对应的音频序号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'Pass' => [ + 'description' => '是否通过检测，取值：'."\n" + ."\n" + .'- true：检测成功。'."\n" + .'- false：检测失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Reason' => [ + 'description' => '检测失败时给出具体原因', + 'type' => 'string', + 'example' => '发音错误，请准确读出文案中的内容', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Pass\\": false,\\n \\"Reason\\": \\"发音错误，请准确读出文案中的内容\\"\\n }\\n}","type":"json"}]', + 'title' => '提交音频检测（基础版）', + ], + 'SubmitCustomizedVoiceJob' => [ + 'summary' => '提交基础版本人声克隆任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声 Id', + 'type' => 'string', + 'required' => true, + 'example' => 'xiaozhuan', + 'maxLength' => 32, + 'minLength' => 0, + ], + ], + [ + 'name' => 'DemoAudioMediaURL', + 'in' => 'query', + 'schema' => [ + 'description' => '示例音频输出地址 '."\n" + .'- 如果传入此参数，则会在训练成功后在此参数表示的 OSS 地址生成示例音频 '."\n" + .'- 如果不传入此参数，则不会生成示例音频'."\n" + .'><notice>需要是您账号下合法的 OSS 公网地址></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.MP3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '是否调用成功，取值：'."\n" + .'- true：调用成功 '."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '人声克隆任务 Id', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + 'VoiceId' => [ + 'description' => '声音 Id', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\",\\n \\"VoiceId\\": \\"xiaozhuan\\"\\n }\\n}","type":"json"}]', + 'title' => '提交人声克隆任务（基础版）', + 'description' => '<props="china">- 人声克隆计费项分为定制和使用两个维度，详情请参见[人声克隆计费](~~2399891#section-gy3-80e-clt~~)。</props>'."\n" + .'- 提交人声克隆任务，VoiceId 需要与音频检测时传递的一致，云端依赖此参数寻找暂存的音频进行训练。 '."\n" + ."\n\n" + .'- 在训练期间，您可以通过调用 [GetCustomizedVoiceJob - 查询人声克隆任务](~~2384473~~)接口来获取当前任务是否完成或训练状态等信息。'."\n" + ."\n" + .'- 调用此接口后，会同步返回 JobId，训练过程为异步过程。', + ], + 'SubmitStandardCustomizedVoiceJob' => [ + 'summary' => '提交大众版本的人声克隆任务。调用此接口后，会同步返回 JobId，训练过程为异步过程。在训练期间，您可以通过调用 GetCustomizedVoiceJob - 查询人声克隆训练任务接口来获取当前任务是否完成或训练状态等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '声音名字，不超过 32 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '小专', + ], + ], + [ + 'name' => 'Gender', + 'in' => 'query', + 'schema' => [ + 'description' => '性别，取值范围：'."\n" + .'- female：女性'."\n" + .'- male：男性', + 'type' => 'string', + 'required' => false, + 'example' => 'female', + ], + ], + [ + 'name' => 'Authentication', + 'in' => 'query', + 'schema' => [ + 'description' => '认证音频媒资 Id，请您上传一段音频验证本人身份，声纹与训练音频不符将定制失败。'."\n" + .'><notice>请清晰朗读并录制如下文案：我确认进行人声克隆定制，训练音频为本人提供，本人承诺对定制内容负责，保证不进行违法违规的内容创作。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****', + ], + ], + [ + 'name' => 'Audios', + 'in' => 'query', + 'schema' => [ + 'description' => '训练声音素材媒资 Id 列表，多个素材 MediaId 用英文逗号分割。'."\n" + ."\n" + .'><notice>所有素材的总时长需要介于 15 - 30 分钟内，单个素材的时长需要大于 1 分钟></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****,****571c704445f9a0ee011406c2****', + ], + ], + [ + 'name' => 'DemoAudioMediaURL', + 'in' => 'query', + 'schema' => [ + 'description' => '示例音频输出地址 '."\n" + .'- 如果传入此参数，则会在训练成功后在此参数表示的 OSS 地址生成示例音频 '."\n" + .'- 如果不传入此参数，则不会生成示例音频'."\n" + .'><notice>需要是您账号下合法的 OSS 公网地址></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.mp3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '人声克隆任务 Id', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<SubmitStandardCustomizedVoiceJobResponse>\\n <RequestId>****63E8B7C7-4812-46AD-0FA56029AC86****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <JobId>****d718e2ff4f018ccf419a7b71****</JobId>\\n </Data>\\n</SubmitStandardCustomizedVoiceJobResponse>","errorExample":""}]', + 'title' => '提交人声克隆任务（大众版）', + ], + 'GetCustomizedVoiceJob' => [ + 'summary' => '查询单个人声克隆任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声克隆任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Data' => [ + 'description' => '调用成功时返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CustomizedVoiceJob' => [ + 'description' => '人声克隆任务。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '人声克隆任务ID。', + 'type' => 'string', + 'example' => '****571c704445f9a0ee011406c2****', + ], + 'VoiceId' => [ + 'description' => '声音ID。', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + 'Status' => [ + 'description' => '任务状态，取值范围：'."\n" + .'- Initialization：初始化'."\n" + .'- AudioDetecting：音频检测中'."\n" + .'- PreTraining：提交训练，待训练'."\n" + .'- Training：训练中'."\n" + .'- Success：训练成功'."\n" + .'- Fail：训练失败', + 'type' => 'string', + 'example' => 'Fail', + ], + 'Message' => [ + 'description' => '状态附加描述信息。', + 'type' => 'string', + 'example' => '训练失败', + ], + 'Type' => [ + 'description' => '人声克隆任务类型，取值范围：'."\n" + ."\n" + .'- Basic：基础版'."\n" + .'- Standard：大众版', + 'type' => 'string', + 'example' => 'Standard', + ], + 'VoiceName' => [ + 'description' => '声音名称。', + 'type' => 'string', + 'example' => '小专', + ], + 'VoiceDesc' => [ + 'description' => '声音描述。', + 'type' => 'string', + 'example' => '这是一个专属人声', + ], + 'Scenario' => [ + 'description' => '场景，取值范围：'."\n" + .'- story：故事'."\n" + .'- interaction：交互'."\n" + .'- navigation：导航', + 'type' => 'string', + 'example' => 'story', + ], + 'Gender' => [ + 'description' => '性别，取值范围如下：'."\n" + ."\n" + .'- female：女性'."\n" + ."\n" + .'- male：男性', + 'type' => 'string', + 'example' => 'female', + ], + 'CreateTime' => [ + 'description' => '创建时间，UTC 时间格式。', + 'type' => 'string', + 'example' => '2023-06-07T02:27:08Z', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '表示是否调用成功：'."\n" + .'- true：调用成功'."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceJob\\": {\\n \\"JobId\\": \\"****571c704445f9a0ee011406c2****\\",\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"Status\\": \\"Fail\\",\\n \\"Message\\": \\"训练失败\\",\\n \\"Type\\": \\"Standard\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是一个专属人声\\",\\n \\"Scenario\\": \\"story\\",\\n \\"Gender\\": \\"female\\",\\n \\"CreateTime\\": \\"2023-06-07T02:27:08Z\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询人声克隆任务', + ], + 'DeleteCustomizedVoiceJob' => [ + 'summary' => '调用此接口可以删除处于非“训练中”与“训练成功”的人声克隆任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声克隆任务 Id', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + .'- true：成功'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除人声克隆任务', + ], + 'ListCustomizedVoiceJobs' => [ + 'summary' => '列出当前用户的所有人声克隆训练任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '人声克隆任务类型（版本），取值范围：'."\n" + .'- Basic 基础版'."\n" + .'- Standard 大众版'."\n" + ."\n" + .'><notice>不填默认为查找 Basic 基础版></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'enum' => [ + 'Basic', + 'Standard', + 'Premium', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'CustomizedVoiceJobList' => [ + 'description' => '人声克隆任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '人声克隆任务', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '人声克隆任务 Id', + 'type' => 'string', + 'example' => '2245ab99a7fd4116a4fd3f499b7a56c5', + ], + 'VoiceId' => [ + 'description' => '声音 Id', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + 'Status' => [ + 'description' => '任务状态，取值：'."\n" + .'- Initialization 初始化'."\n" + .'- AudioDetecting 音频检测中'."\n" + .'- PreTraining 提交训练，待训练'."\n" + .'- Training 训练中'."\n" + .'- Success 训练成功'."\n" + .'- Fail 训练失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '状态附加描述信息', + 'type' => 'string', + 'example' => '训练成功', + ], + 'VoiceName' => [ + 'description' => '声音名字（一般为中文名）'."\n" + .'- 不超过 32 个字符', + 'type' => 'string', + 'example' => '小专', + ], + 'VoiceDesc' => [ + 'description' => '声音描述'."\n" + .'- 不超过 256 个字符', + 'type' => 'string', + 'example' => '这是这个声音的描述', + ], + 'Type' => [ + 'description' => '- 声音类型，取值范围：'."\n" + .' - Basic 基础版'."\n" + .' - Standard 大众版', + 'type' => 'string', + 'example' => 'Standard', + ], + 'Gender' => [ + 'description' => '性别，取值范围：'."\n" + .'- female：女性'."\n" + .'- male：男性', + 'type' => 'string', + 'example' => 'female', + ], + 'Scenario' => [ + 'description' => '场景，取值范围：'."\n" + .'- story：故事'."\n" + .'- interaction：交互'."\n" + .'- navigation：导航', + 'type' => 'string', + 'example' => 'story', + ], + 'CreateTime' => [ + 'description' => '- 任务创建时间'."\n" + .'- 格式为 UTC 时间', + 'type' => 'string', + 'example' => '2023-04-01T06:23:59Z', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-06-27T02:42:28Z', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '271', + ], + ], + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceJobList\\": [\\n {\\n \\"JobId\\": \\"2245ab99a7fd4116a4fd3f499b7a56c5\\",\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"训练成功\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是这个声音的描述\\",\\n \\"Type\\": \\"Standard\\",\\n \\"Gender\\": \\"female\\",\\n \\"Scenario\\": \\"story\\",\\n \\"CreateTime\\": \\"2023-04-01T06:23:59Z\\",\\n \\"GmtCreate\\": \\"2022-06-27T02:42:28Z\\"\\n }\\n ],\\n \\"TotalCount\\": 271\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询人声克隆任务列表 ', + ], + 'GetCustomizedVoice' => [ + 'summary' => '调用本接口可以查询特定的个性化人声信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声 Id', + 'type' => 'string', + 'required' => false, + 'example' => 'xiaozhuan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'CustomizedVoice' => [ + 'description' => '个性化人声', + 'type' => 'object', + 'properties' => [ + 'VoiceId' => [ + 'description' => '声音 Id', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + 'VoiceName' => [ + 'description' => '声音名字', + 'type' => 'string', + 'example' => '小专', + ], + 'VoiceDesc' => [ + 'description' => '声音描述', + 'type' => 'string', + 'example' => '这是一个个性化人声', + ], + 'Gender' => [ + 'description' => '性别，取值范围如下：'."\n" + ."\n" + .'- female：女性'."\n" + ."\n" + .'- male：男性', + 'type' => 'string', + 'example' => 'female', + ], + 'Scenario' => [ + 'description' => '示范场景。'."\n" + ."\n" + .'可以取以下的一个值：'."\n" + ."\n" + .'- **story**：故事'."\n" + .'- **interaction**：交互'."\n" + .'- **navigation**：导航', + 'type' => 'string', + 'example' => 'interaction', + ], + 'DemoAudioMediaId' => [ + 'description' => '示例音频媒资 Id', + 'type' => 'string', + 'example' => '****42d3c312402982be65975f5b****', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"Data\\": {\\n \\"CustomizedVoice\\": {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是一个个性化人声\\",\\n \\"Gender\\": \\"female\\",\\n \\"Scenario\\": \\"interaction\\",\\n \\"DemoAudioMediaId\\": \\"****42d3c312402982be65975f5b****\\"\\n }\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询个性化人声', + ], + 'UpdateCustomizedVoice' => [ + 'summary' => '调用此接口可以修改个性化人声的信息，目前仅支持修改示例音频媒资ID，以支持自行维护示例音频。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'VoiceId', + 'in' => 'query', + 'schema' => [ + 'description' => '人声 Id', + 'type' => 'string', + 'required' => true, + 'example' => 'xiaozhuan', + ], + ], + [ + 'name' => 'DemoAudioMediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '示例音频媒资 Id', + 'type' => 'string', + 'required' => false, + 'example' => '****4d5e829d498aaf966b119348****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '4E84BE44-58A7-****-****-FBEBEA16EF94', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E84BE44-58A7-****-****-FBEBEA16EF94\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新个性化人声信息', + ], + 'ListCustomizedVoices' => [ + 'summary' => '列出当前用户的所有的个性化人声。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '- 声音类型，取值范围：'."\n" + .' - Basic 基础版'."\n" + .' - Standard 大众版'."\n" + .'- 不填默认为 Basic，查询基础版', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Data' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'CustomizedVoiceList' => [ + 'description' => '个性化人声列表', + 'type' => 'array', + 'items' => [ + 'description' => '个性化人声', + 'type' => 'object', + 'properties' => [ + 'VoiceId' => [ + 'description' => '声音 Id', + 'type' => 'string', + 'example' => 'xiaozhuan', + ], + 'VoiceName' => [ + 'description' => '声音名字（一般为中文名）', + 'type' => 'string', + 'example' => '小专', + ], + 'VoiceDesc' => [ + 'description' => '声音描述', + 'type' => 'string', + 'example' => '这是一个个性化人声小专', + ], + 'Gender' => [ + 'description' => '性别，取值范围：'."\n" + .'- female：女性'."\n" + .'- male：男性', + 'type' => 'string', + 'example' => 'male', + ], + 'Scenario' => [ + 'description' => '场景，取值范围：'."\n" + .'- story：故事'."\n" + .'- interaction：交互'."\n" + .'- navigation：导航', + 'type' => 'string', + 'example' => 'story', + ], + 'DemoAudioMediaId' => [ + 'description' => '示例音频媒资 Id', + 'type' => 'string', + 'example' => '****4d5e829d498aaf966b119348****', + ], + 'Type' => [ + 'description' => '- 声音类型，取值范围：'."\n" + .' - Basic 基础版'."\n" + .' - Standard 大众版', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '41', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功，取值：'."\n" + .'- true：成功'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Data\\": {\\n \\"CustomizedVoiceList\\": [\\n {\\n \\"VoiceId\\": \\"xiaozhuan\\",\\n \\"VoiceName\\": \\"小专\\",\\n \\"VoiceDesc\\": \\"这是一个个性化人声小专\\",\\n \\"Gender\\": \\"male\\",\\n \\"Scenario\\": \\"story\\",\\n \\"DemoAudioMediaId\\": \\"****4d5e829d498aaf966b119348****\\",\\n \\"Type\\": \\"Standard\\"\\n }\\n ],\\n \\"TotalCount\\": 41\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询个性化人声列表 ', + ], + 'SubmitASRJob' => [ + 'summary' => '根据视频语音提取时间起止点及对应文字信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputFile', + 'in' => 'query', + 'schema' => [ + 'title' => '输入配置，支持OSS地址和内容库素材ID', + 'description' => '输入配置，支持OSS地址和内容库素材ID', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义设置，为JSON字符串', + 'description' => '用户自定义设置，可传入客户业务信息，如业务方环境、任务信息，JSON字符串格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "user": "data",'."\n" + .' "env": "prod"'."\n" + .'}', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '任务标题', + 'description' => '任务标题，长度不超过128字节', + 'type' => 'string', + 'required' => false, + 'example' => '测试标题', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '任务描述', + 'description' => '任务描述，长度不超过128字节', + 'type' => 'string', + 'required' => false, + 'example' => '测试描述', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'title' => '持续时间', + 'description' => '持续时间', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:10', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '音频识别转文字配置：'."\n" + ."\n" + .'- HotwordLibraryIdList，热词库Id列表，目前仅支持传入一个热词库Id，后续计划支持同时多个热词库Id', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "HotwordLibraryIdList": "******2609a14f54a0636b7e16******"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '智能任务Id', + 'description' => '智能任务Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'State' => [ + 'title' => '任务状态', + 'description' => '任务状态'."\n" + .'- Created'."\n" + .'- Executing'."\n" + .'- Finished'."\n" + .'- Failed', + 'type' => 'string', + 'example' => 'Finished', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Finished\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitASRJobResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <State>Finished</State>\\n</SubmitASRJobResponse>","errorExample":""}]', + 'title' => '提交ASR智能字幕任务', + 'responseParamsDescription' => 'ASR任务执行结果可以用ASR任务JobId通过[获取智能任务结果](~~441172~~)接口查询任务执行详细信息，任务执行成功时[获取智能任务结果](~~441172~~)接口返回结果示例如下。'."\n" + ."\n\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" + .' "JobResult": {'."\n" + .' "AiResult": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" + .' },'."\n" + .' "State": "Finished",'."\n" + .' "Output": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在的可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]",'."\n" + .' "JobId": "******042d5e4db6866f6289d1******",'."\n" + .' "SmartJobInfo": {'."\n" + .' "JobType": "ASR",'."\n" + .' "ModifiedTime": "2022-01-21T06:15:08Z",'."\n" + .' "UserId": 1234562230123456,'."\n" + .' "CreateTime": "2022-01-21T06:15:02Z",'."\n" + .' "Title": "default_title_2022-01-21T06:15:02Z",'."\n" + .' "InputConfig": {'."\n" + .' "JobParameters": "{\\"duration\\":\\"00:30:00\\",\\"start_time\\":\\"00:00:00\\",\\"request_params\\":\\"&enable_word_level_result=true\\"}",'."\n" + .' "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'SubmitAvatarVideoJob' => [ + 'summary' => '以人声音频或文本作为输入，渲染虚拟人视频。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InputConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟人任务输入参数。支持以文本、音频OSS文件、媒资作为输入。音频仅支持mp3或wav格式。'."\n" + .'><notice>Text 的输入内容长度不能少于 5 个字。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '{"Text": "君不见黄河之水天上来，奔流到海不复回。君不见高堂明镜悲白发，朝如青丝暮成雪。"}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟人任务配置信息，支持设置虚拟人id、人声、语速等信息', + 'type' => 'string', + 'required' => false, + 'example' => '{"AvatarId":"yunqiao"}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '任务输出信息，支持设置输出地址', + 'type' => 'string', + 'required' => false, + 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4"}', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '任务标题', + 'description' => '任务标题，长度不超过128字节', + 'type' => 'string', + 'required' => false, + 'example' => '测试标题', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '任务描述', + 'description' => '任务描述，长度不超过128字节', + 'type' => 'string', + 'required' => false, + 'example' => '测试描述', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义设置，为JSON字符串', + 'description' => '用户自定义设置，可传入客户业务信息，如业务方环境、任务信息，JSON字符串格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"user":"data","env":"prod"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******'."\n", + ], + 'JobId' => [ + 'description' => '智能任务Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****'."\n", + ], + 'MediaId' => [ + 'description' => '成片媒资id', + 'type' => 'string', + 'example' => '******70dcc471edaf00e6f6f4******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\\\n\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\\\n\\",\\n \\"MediaId\\": \\"******70dcc471edaf00e6f6f4******\\"\\n}","type":"json"}]', + 'title' => '提交数字人渲染任务', + 'description' => '- 目前仅支持输入为文本或人声音频作为输入，音频仅支持mp3或wav格式。'."\n" + .'- 支持输出mp4和webm格式。当输出为mp4时，成片为带绿幕背景的视频，同时输出虚拟人的蒙版视频，供后续使用，推荐用这个方案。当输出为webm时，成片为带透明通道的webm，可用于前端展示，由于webm编码问题，合成会慢一些。'."\n" + .'- 输出结果中包含人声的句子时间戳，供后续在剪辑中使用。', + 'requestParamsDescription' => '### InputConfig示例：'."\n" + .'输入为音频地址：'."\n" + .'```'."\n" + .'{'."\n" + .' "InputFile": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp3"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'输入为文本：'."\n" + .'```'."\n" + .'{'."\n" + .' "Text": "君不见黄河之水天上来，奔流到海不复回。君不见高堂明镜悲白发，朝如青丝暮成雪。"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'输入为MediaId：'."\n" + .'```'."\n" + .'{'."\n" + .' "MediaId": "4aef0c80cc0071edbf92f6e7c44b6302"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### EditingConfig示例：'."\n" + .'AvatarId：虚拟人形象Id，必填 ，取值：[数字人官方形象](https://help.aliyun.com/document_detail/2254005.html) '."\n" + .'Voice：发音人，仅输入为Text有效，选填，取值：[智能语音效果示例](https://help.aliyun.com/document_detail/449563.html) '."\n" + .'CustomizedVoice：个性化人声。如果需要使用通过人声克隆生成的个性化人声作为发音人，请使用此字段，而不是 Voice 字段 '."\n" + .'LoopMotion: 是否首尾同帧，如果设置此值为 true，则生成的数字人视频图像的首帧与尾帧相同，循环播放视频时人物形象的动作和表情不会有“跳变”现象，取值范围：{true, false}，默认值：false '."\n" + .'SpeechRate：语速，仅当输入为文本类型有效，取值范围：-500～500，默认值：0 '."\n" + .'PitchRate：音调，仅当输入为文本类型有效，取值范围：-500～500，默认值：0 '."\n" + .'Volume：音量，仅当输入为文本类型有效，取值范围：0~100，默认值50 '."\n" + .'BackgroundUrl：背景图，选填，不传默认是黑色背景，仅支持jpg、png格式；分辨率要求为 1080P，如果使用的是竖屏形象，则要求为 1080P 竖屏，如果使用的是横屏形象，则要求为 1080P 横屏。'."\n" + .'```'."\n" + .'{'."\n" + .' "AvatarId": "xinxin-marketing_standing", '."\n" + .' "BackgroundUrl": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.jpg",'."\n" + .' "Voice" : "zhichu",'."\n" + .' "LoopMotion": true,'."\n" + .' "SpeechRate": 100,'."\n" + .' "PitchRate": 10, '."\n" + .' "Volume": 10 '."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### OutputConfig示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/xxx.mp4'."\n" + .'}'."\n" + .'```', + 'responseParamsDescription' => '可以通过[获取智能任务结果](https://help.aliyun.com/document_detail/203429.html)接口查询任务执行状态和任务结果，任务执行成功时接口返回结果示例如下. '."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "2014D1A8-4143-164F-94B4-32B8F39B706D",'."\n" + .' "JobId": "d9367da8c7184ec7a3f24de530ac5b9a",'."\n" + .' "State": "Finished",'."\n" + .' "SmartJobInfo": {'."\n" + .' "Title": "default_title_2023-03-28T13:37:47Z",'."\n" + .' "EditingConfig": "null",'."\n" + .' "JobType": "AvatarVideo",'."\n" + .' "CreateTime": "2023-03-28T13:37:47Z",'."\n" + .' "ModifiedTime": "2023-03-28T13:37:47Z",'."\n" + .' "UserId": 1833202230108227,'."\n" + .' "outputConfig": {'."\n" + .' "mediaUrl": "https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4"'."\n" + .' }'."\n" + .' },'."\n" + .' "JobResult": {'."\n" + .' "MediaId": "4aef0c80cc0071edbf92f6e7c44b6302",'."\n" + .' "AiResult": "{\\"outputVideoUrl\\":\\"https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4\\",\\"subtitleClips\\":\\"[{\\\\\\"from\\\\\\":0.0,\\\\\\"to\\\\\\":4.692,\\\\\\"content\\\\\\":\\\\\\"君不见黄河之水天上来，奔流到海不复回。\\\\\\"},{\\\\\\"from\\\\\\":4.692,\\\\\\"to\\\\\\":9.061,\\\\\\"content\\\\\\":\\\\\\"君不见高堂明镜悲白发，朝如青丝暮成雪。\\\\\\"}]\\"}"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'其中，AiResult格式如下： '."\n" + .'outputVideoUrl 为输出成片地址，mp4格式 '."\n" + .'subtitleClips 字幕句子时间戳 '."\n" + .'```'."\n" + .'{'."\n" + .' "outputVideoUrl": "https://oushu-test-shanghai.oss-cn-shanghai.aliyuncs.com/avatar/222.mp4",'."\n" + .' "subtitleClips": "[{\\"from\\":0.0,\\"to\\":4.692,\\"content\\":\\"君不见黄河之水天上来，奔流到海不复回。\\"},{\\"from\\":4.692,\\"to\\":9.061,\\"content\\":\\"君不见高堂明镜悲白发，朝如青丝暮成雪。\\"}]"'."\n" + .'}'."\n" + .'```', + ], + 'SubmitAudioProduceJob' => [ + 'summary' => '本接口用于将提供的文本内容转换成高质量的语音音频文件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EditingConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '音频生产配置', + 'description' => '音频生产配置：'."\n" + .'- voice [声音类型](~~449563~~)'."\n" + .'- customizedVoice 人声克隆的 VoiceId'."\n" + .'- format 输出文件格式，支持：PCM/WAV/MP3'."\n" + .'- volume 音量，取值0~100，默认值50'."\n" + .'- speech_rate 语速，取值范围：-500～500，默认值：0'."\n" + .' - [-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]'."\n" + .' - 计算方法如下：'."\n" + .' - 0.8倍速（1-1/0.8）/0.002 = -125'."\n" + .' - 1.2倍速（1-1/1.2）/0.001 = 166'."\n" + .' - 小于1倍速时，使用0.002系数'."\n" + .' - 大于1倍速时，使用0.001系数'."\n" + .'- pitch_rate 语调，取值范围：-500～500，默认值：0'."\n" + .'<notice>如果同时传入voice和customizedVoice会优先使用customizedVoice。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '{"voice":"Siqi","format":"MP3","volume":50}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '音频输出配置', + 'description' => '音频输出配置', + 'type' => 'string', + 'required' => true, + 'example' => '例如将输出的语音存至：http://my_bucket.oss-cn-shanghai.aliyuncs.com/target_audio.mp3，则此参数配置为：'."\n" + .'{'."\n" + .' "bucket": "my_bucket",'."\n" + .' "object": "target_audio"'."\n" + .'}', + ], + ], + [ + 'name' => 'InputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '文本内容。 最大支持300个汉字', + 'description' => '文本内容，最大支持10000个汉字。支持[SSML标记语言](~~2672807~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '测试文本', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '任务标题', + 'description' => '任务标题。若不提供，根据日期自动生成默认title'."\n" + .'- 长度不超过128字节'."\n" + .'- UTF8编码'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '任务标题。'."\n" + .'若不提供，根据日期自动生成默认title '."\n" + .'长度不超过128字节 UTF8编码', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '任务描述', + 'description' => '任务描述：'."\n" + .'- 长度不超过1024字节'."\n" + .'- UTF8编码', + 'type' => 'string', + 'required' => false, + 'example' => '任务描述长度不超过1024字节 UTF8编码', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义数据', + 'description' => '自定义设置，Json 格式，长度限制为 512 字节。支持[自定义回调地址配置](~~451631~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'Overwrite', + 'in' => 'query', + 'schema' => [ + 'title' => '是否覆盖现有OSS文件', + 'description' => '是否覆盖现有OSS文件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'State' => [ + 'title' => '任务状态', + 'description' => '任务状态：'."\n" + .'- Created'."\n" + .'- Executing'."\n" + .'- Finished'."\n" + .'- Failed', + 'type' => 'string', + 'example' => 'Created', + ], + 'MediaId' => [ + 'title' => '媒资Id', + 'description' => '媒资Id', + 'type' => 'string', + 'example' => '****2bcbfcfa30fccb36f72dca22****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"State\\": \\"Created\\",\\n \\"MediaId\\": \\"****2bcbfcfa30fccb36f72dca22****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitAudioProduceJobResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <State>Created</State>\\n</SubmitAudioProduceJobResponse>","errorExample":""}]', + 'title' => '提交智能语音任务', + 'responseParamsDescription' => '智能语音任务执行结果可以用智能语音任务JobId通过[获取智能任务结果接口](~~441172~~)查询任务执行详细信息，任务执行成功时[获取智能任务结果接口](~~441172~~)返回结果示例如下。'."\n" + .'> AI_TTS默认根据中文逗号、句号等标点符号进行断句'."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" + .' "JobId": "******042d5e4db6866f6289d1******",'."\n" + .' "State": "Finished",'."\n" + .' "SmartJobInfo": {'."\n" + .' "Title": "default_title_2022-01-21T06:15:07Z",'."\n" + .' "JobType": "TextToSpeech",'."\n" + .' "CreateTime": "2022-01-21T06:15:07Z",'."\n" + .' "ModifiedTime": "2022-01-21T06:15:07Z",'."\n" + .' "InputConfig": {'."\n" + .' "InputFile": "提起郭德纲，现在可以说是红的发紫了，常常票价很高，但是一开手就被疯抢一空，还参加各种相声综艺节目点评新人表演演员已经"'."\n" + .' },'."\n" + .' "EditingConfig": "{\\"format\\":\\"MP3\\",\\"pitch_rate\\":0,\\"sample_rate\\":16000,\\"speech_rate\\":0,\\"voice\\":\\"Siqi\\",\\"volume\\":50}",'."\n" + .' "OutputConfig": {'."\n" + .' "Bucket": "your-bucket",'."\n" + .' "Object": "your-audio"'."\n" + .' }'."\n" + .' },'."\n" + .' "JobResult": {'."\n" + .' "MediaId": "******bf47c94e82b3b2014361******",'."\n" + .' "AiResult": "[{\\"text\\":\\"提起\\",\\"begin_time\\":0,\\"end_time\\":846},{\\"text\\":\\"现在可以说是红的发紫了\\",\\"begin_time\\":846,\\"end_time\\":3386},{\\"text\\":\\"常常票价很高\\",\\"begin_time\\":3386,\\"end_time\\":4402},{\\"text\\":\\"但是一开手就被疯抢一空\\",\\"begin_time\\":4402,\\"end_time\\":6265},{\\"text\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"begin_time\\":6265,\\"end_time\\":10330}]"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'SubmitTextGenerateJob' => [ + 'summary' => '根据提交的关键词、字数、文案数，扩写出营销文案。由于中文的特殊性，输出文案字数可能跟需求字数有出入。提交任务成功后，根据JobId调用GetSmartHandleJob接口获取任务状态和结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '209430', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '任务标题'."\n" + ."\n" + .'\\- 长度不超过128字节。'."\n" + ."\n" + .'\\- UTF8编码。', + 'type' => 'string', + 'required' => false, + 'example' => '测试标题', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '任务描述，长度不超过1024字节（UTF8编码）', + 'type' => 'string', + 'required' => false, + 'example' => '测试描述', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型'."\n" + ."\n" + .'**枚举值：**'."\n" + .'- MarketingCopy：营销文案。'."\n" + .'- Title：短视频标题。'."\n" + .'- StoryboardScript：文案生成分镜脚本。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MarketingCopy' => '营销文案', + 'Title' => '短视频标题', + ], + 'example' => 'MarketingCopy', + ], + ], + [ + 'name' => 'GenerateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '生成配置。'."\n" + ."\n" + .'Type = Title 或MarketingCopy时，需填写以下字段：'."\n" + .'- keywords：生成标题或营销文案的关键词。必填。'."\n" + .'- textLength：生成文案的字数，取值范围 5~1000。实际生成的文案字数可能略少于或等于此值，但不会超过。必填。'."\n" + .'- targetCount：生成的文案数量，取值范围 1~1000。必填。'."\n" + ."\n" + .'Type = StoryboardScript 时，需填写以下字段：'."\n" + .'- originText：用于生成分镜脚本的原始文案，必填。', + 'type' => 'string', + 'required' => false, + 'example' => '{"keywords":"新开店蛋糕，动物奶油","textLength":100,"targetCount":3} '."\n" + .'或'."\n" + .'{"originText": "街边新开了一家蛋糕店，售卖奶油蛋糕、水果蛋糕、面包、松饼等。蛋糕店对面开了一家咖啡馆，客人络绎不绝。"}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，Json 格式，长度限制为 512 字节。支持[自定义回调地址配置](~~451631~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '智能任务ID', + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', + 'title' => '提交关键词扩写任务', + 'description' => '- 使用该接口前，您需要购买【企业订阅服务】，以获得功能使用权限<props="china">，详情请参见[订阅计费制](~~439260#3285adfad70dw~~)</props>。'."\n" + .'- 该接口按照生成内容的'."\n" + .' token 数量进行计费，token 数与生成文本的字数呈正相关。详情请参见[智能一键成片](~~2840901~~)。如果合成任务失败，将不会产生费用。', + ], + 'SubmitVideoTranslationJob' => [ + 'summary' => '通过本接口，您可以提交视频翻译任务。当前已支持字幕级翻译（将视频中出现的字幕翻译为指定语言）、声音（口播）级翻译（将音频中的口播内容翻译为指定语言）与面容级翻译（口型适配）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '222559', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '视频翻译任务的输入参数'."\n" + .'- 支持以视频、字幕文件作为输入'."\n" + .'- 符合 JSON 格式', + 'type' => 'string', + 'required' => false, + 'example' => '{"Type":"Video","Video":"1628ae20c36******8f6f7c77a6302"}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '视频翻译任务的配置参数，符合 JSON 格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"SourceLanguage":"zh","TargetLanguage":"en","DetextArea":"Auto"}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '视频翻译任务的输出参数，支持以视频类型、字幕文件类型输出。', + 'type' => 'string', + 'required' => false, + 'example' => '{"MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.mp4"}', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '任务标题。', + 'type' => 'string', + 'required' => false, + 'example' => '测试标题', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'required' => false, + 'example' => '测试描述', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义信息，Json 格式，长度限制为 512 字节。'."\n" + .'- [支持自定义回调地址配置](~~451631~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => '测试 ClientToken', + ], + ], + [ + 'name' => 'SignatureMehtod', + 'in' => 'query', + 'schema' => [ + 'description' => '自动补全，无需写入', + 'type' => 'string', + 'required' => false, + 'example' => '自动补全，无需写入', + ], + ], + [ + 'name' => 'SignatureType', + 'in' => 'query', + 'schema' => [ + 'description' => '自动补全，无需写入', + 'type' => 'string', + 'required' => false, + 'example' => '自动补全，无需写入', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '视频翻译任务 ID', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\"\\n }\\n}","type":"json"}]', + 'title' => '提交视频翻译任务', + 'description' => '- 在此接口中，所有媒资的OSS URL中的区域（region）必须与调用OpenAPI服务地址中的区域（region）保持一致。'."\n" + ."\n\n" + .'- 该接口支持每秒30次请求（QPS 30）。提交任务多时，会自动进入队列并动态扩容处理，无并发执行数量限制。'."\n" + ."\n" + .'- 提交视频翻译任务，返回'."\n" + .' JobId，后续可通过 JobId 调用 [GetSmartHandleJob](~~441172~~) 接口来获取任务的状态及结果信息。'."\n" + .'><notice>本接口详细的参数说明与示例，请以此文档为准：<props="china">[视频翻译参数介绍与示例](https://help.aliyun.com/zh/ims/use-cases/introduction-and-examples-of-video-translation-parameters)</props>'."\n" + .'<props="intl">[视频翻译参数介绍与示例](~~2852702~~)</props>'."\n" + .'></notice>', + 'requestParamsDescription' => '详细的参数说明与示例，请参考：[视频翻译参数介绍与示例](~~2852702~~)', + ], + 'SubmitHighlightExtractionJob' => [ + 'summary' => '提交高光提取任务。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '调用方保证请求幂等性Client Token', + 'description' => '调用方保证请求幂等性Client Token', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****'."\n", + ], + ], + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置，详见：[InputConfig参数说明](~~2869391#e72301e3a74mk~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaArray": [{'."\n" + .' "MediaId": "ceb72f00e****1ef8216e7e6c64a6302"'."\n" + .' }, {'."\n" + .' "MediaId": "ce450c40e****1ef8216e7e6c64a6302"'."\n" + .' }, {'."\n" + .' "MediaId": "ce49a020e****1ef81c1e6f6d5686302"'."\n" + .' }, {'."\n" + .' "MediaId": "d047e120e****1ef81c1e6f6d5686302"'."\n" + .' }, {'."\n" + .' "MediaId": "cfe2ddc0e****1ef81c1e6f6d5686302"'."\n" + .' }],'."\n" + .' "Strategy": {'."\n" + .' "Count": 5,'."\n" + .' "ClipDuration": 15'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置，详见：[OutputConfig参数说明](~~2869391#cd08cbc516voq~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "NeedExport": true,'."\n" + .' "OutputMediaTarget": "oss-object",'."\n" + .' "Bucket": "test-bucket",'."\n" + .' "ObjectKey": "path/to/test_{index}.mp4",'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "ExportAsNewMedia": false'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置](~~357745#section-urj-v3f-0s1~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'JobId' => [ + 'title' => '批量混剪任务jobId', + 'description' => '高光提取任务jobId', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\"\\n}","type":"json"}]', + 'title' => '提交高光提取任务', + ], + 'SubmitSegmentationJob' => [ + 'summary' => '将一个长视频拆分成多个视频片段，输出多个视频文件或输出为媒资。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '调用方保证请求幂等性Client Token', + 'description' => '调用方保证请求幂等性Client Token', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置，详情见[InputConfig](~~2874121#cc59ad3082jbx~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Type": "OSS",'."\n" + .' "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .'}'."\n" + .'或 {'."\n" + .' "Type": "Media",'."\n" + .' "Media": "ce49a020e****1ef81c1e6f6d5686302"'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置，详情见[OutputConfig](~~2874121#cef23186a8d6w~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "OutputMediaTarget": "oss-object",'."\n" + .' "Bucket": "test-bucket",'."\n" + .' "ObjectKey": "path/to/test_{index}.mp4",'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "ExportAsNewMedia": false'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户配置UserData。自定义设置，Json 格式，长度限制为 512 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"test": "22"}', + ], + ], + [ + 'name' => 'JobParams', + 'in' => 'query', + 'schema' => [ + 'description' => '任务参数，详情见[JobParams](~~2874121#a60357f2d5iix~~)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Mode": "UserDefined",'."\n" + .' "Ranges": [{'."\n" + .' "In": 10,'."\n" + .' "Out": 20'."\n" + .' }, {'."\n" + .' "In": 35,'."\n" + .' "Out": 50'."\n" + .' }]'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******'."\n", + ], + 'JobId' => [ + 'title' => '批量混剪任务jobId', + 'description' => '拆条任务jobId', + 'type' => 'string', + 'example' => '****cdb3e74639973036bc84****'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\\\n\\",\\n \\"JobId\\": \\"****cdb3e74639973036bc84****\\\\n\\"\\n}","type":"json"}]', + 'title' => '提交拆条任务', + ], + 'GetSmartHandleJob' => [ + 'summary' => '获取智能任务结果，可以根据任务ID，获取智能任务信息及执行结果。'."\n" + .'本接口仅支持查询近一年的剪辑任务数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务Id', + 'description' => '任务Id', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '任务Id', + 'description' => '任务Id。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Output' => [ + 'title' => '任务结果', + 'description' => '任务结果。', + 'type' => 'string', + 'example' => '{}', + ], + 'JobResult' => [ + 'description' => '任务结果', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资Id', + 'description' => '媒资Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'AiResult' => [ + 'title' => '智能分析结果', + 'description' => '智能分析结果', + 'type' => 'string', + 'example' => '拆条或智能标签信息', + ], + 'Usage' => [ + 'description' => 'Token使用量，仅在关键词扩写任务会返回', + 'type' => 'string', + 'example' => '{"total_tokens":100}', + ], + 'MediaUrl' => [ + 'type' => 'string', + ], + ], + ], + 'State' => [ + 'title' => '任务状态', + 'description' => '任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finished' => '执行成功', + 'Failed' => '执行失败', + 'Executing' => '执行中', + 'Created' => '任务提交成功', + ], + 'example' => 'Finished', + ], + 'UserData' => [ + 'title' => '用户自定义信息', + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"user":"data"}', + ], + 'SmartJobInfo' => [ + 'title' => '智能任务信息', + 'description' => '智能任务信息。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '任务标题', + 'description' => '任务标题。', + 'type' => 'string', + 'example' => '测试标题', + ], + 'Description' => [ + 'title' => '任务描述', + 'description' => '任务描述。', + 'type' => 'string', + 'example' => '测试描述', + ], + 'UserId' => [ + 'title' => 'userid', + 'description' => 'userid。', + 'type' => 'string', + 'example' => '1974526429******', + ], + 'InputConfig' => [ + 'title' => '输入参数', + 'description' => '输入参数。', + 'type' => 'object', + 'properties' => [ + 'InputFile' => [ + 'title' => 'OSS地址 或 内容库素材ID', + 'description' => 'OSS地址或内容库素材ID。', + 'type' => 'string', + 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + 'OutputConfig' => [ + 'title' => '输出配置', + 'description' => '输出配置。', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => 'OSS Bucket', + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'Object' => [ + 'title' => 'OSS Object', + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'test-object', + ], + ], + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'ModifiedTime' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'JobType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ASR', + ], + ], + ], + 'ErrorCode' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Output\\": \\"{}\\",\\n \\"JobResult\\": {\\n \\"MediaId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"AiResult\\": \\"拆条或智能标签信息\\",\\n \\"Usage\\": \\"{\\\\\\"total_tokens\\\\\\":100}\\",\\n \\"MediaUrl\\": \\"\\"\\n },\\n \\"State\\": \\"Finished\\",\\n \\"UserData\\": \\"{\\\\\\"user\\\\\\":\\\\\\"data\\\\\\"}\\",\\n \\"SmartJobInfo\\": {\\n \\"Title\\": \\"测试标题\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"UserId\\": \\"1974526429******\\",\\n \\"InputConfig\\": {\\n \\"InputFile\\": \\"oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******11-DB8D-4A9A-875B-275798******\\"\\n },\\n \\"OutputConfig\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Object\\": \\"test-object\\"\\n },\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"JobType\\": \\"ASR\\"\\n },\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSmartHandleJobResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <Output>{}</Output>\\n <State>Finished</State>\\n <UserData>{\\"user\\":\\"data\\"}</UserData>\\n <SmartJobInfo>\\n <Title>测试标题</Title>\\n <Description>测试描述</Description>\\n <UserId>1974526429******</UserId>\\n <InputConfig>\\n <InputFile>oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 ******11-DB8D-4A9A-875B-275798******</InputFile>\\n </InputConfig>\\n <OutputConfig>\\n <Bucket>test-bucket</Bucket>\\n <Object>test-object</Object>\\n </OutputConfig>\\n <CreateTime>2020-12-26T04:11:10Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <JobType>ASR</JobType>\\n </SmartJobInfo>\\n</GetSmartHandleJobResponse>","errorExample":""}]', + 'title' => '获取智能任务结果', + 'responseParamsDescription' => '每一种类型的智能任务在获取执行结果时返回内容在格式上有所不同，以下为您展示各种智能任务执行结果的具体示例。'."\n" + .'## ASR智能字幕任务'."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" + .' "JobId": "******042d5e4db6866f6289d1******",'."\n" + .' "State": "Finished",'."\n" + .' "SmartJobInfo": {'."\n" + .' "JobType": "ASR",'."\n" + .' "ModifiedTime": "2022-01-21T06:15:08Z",'."\n" + .' "CreateTime": "2022-01-21T06:15:02Z",'."\n" + .' "Title": "default_title_2022-01-21T06:15:02Z",'."\n" + .' "InputConfig": {'."\n" + .' "JobParameters": "{\\"duration\\":\\"00:30:00\\",\\"start_time\\":\\"00:00:00\\",\\"request_params\\":\\"&enable_word_level_result=true\\"}",'."\n" + .' "InputFile": "oss://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4"'."\n" + .' }'."\n" + .' },'."\n" + .' "JobResult": {'."\n" + .' "AiResult": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## 智能语音任务'."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" + .' "JobId": "******042d5e4db6866f6289d1******",'."\n" + .' "State": "Finished",'."\n" + .' "SmartJobInfo": {'."\n" + .' "Title": "default_title_2022-01-21T06:15:07Z",'."\n" + .' "JobType": "TextToSpeech",'."\n" + .' "CreateTime": "2022-01-21T06:15:07Z",'."\n" + .' "ModifiedTime": "2022-01-21T06:15:07Z",'."\n" + .' "InputConfig": {'."\n" + .' "InputFile": "提起，现在可以说是红的发紫了，常常票价很高，但是一开手就被疯抢一空，还参加各种相声综艺节目点评新人表演演员已经"'."\n" + .' },'."\n" + .' "EditingConfig": "{\\"format\\":\\"MP3\\",\\"pitch_rate\\":0,\\"sample_rate\\":16000,\\"speech_rate\\":0,\\"voice\\":\\"Siqi\\",\\"volume\\":50}",'."\n" + .' "OutputConfig": {'."\n" + .' "Bucket": "your-bucket",'."\n" + .' "Object": "your-audio"'."\n" + .' }'."\n" + .' },'."\n" + .' "JobResult": {'."\n" + .' "MediaId": "******bf47c94e82b3b2014361******",'."\n" + .' "AiResult": "[{\\"content\\":\\"提起\\",\\"from\\":0.0,\\"to\\":0.846},{\\"content\\":\\"现在可以说是红的发紫了\\",\\"from\\":0.846,\\"to\\":3.386},{\\"content\\":\\"常常票价很高\\",\\"from\\":3.386,\\"to\\":4.402},{\\"content\\":\\"但是一开手就被疯抢一空\\",\\"from\\":4.402,\\"to\\":6.265},{\\"content\\":\\"还参加各种相声综艺节目点评新人表演演员已经\\",\\"from\\":6.265,\\"to\\":10.33}]"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## 关键词扩写任务'."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId":"******AC-5A01-1116-87A4-BF86F2******",'."\n" + .' "UserData":"{\\"NotifyAddress\\":\\"https://****\\"}",'."\n" + .' "JobResult":{'."\n" + .' "AiResult":"[\\"新开店蛋糕，选用纯正动物奶油，口感醇厚如丝般顺滑，每一口都是甜蜜的惊喜，让味蕾在新鲜与纯粹中翩翩起舞！\\",\\"探索甜品新世界，我们的新开店蛋糕精选优质动物奶油，低甜不腻，层次丰富，每一款都承载着匠心独运的甜蜜故事，静待您来品味。\\",\\"献给懂生活的你，新开业蛋糕店，严选动物奶油，拒绝人工添加，纯正奶香四溢，轻盈绵密，每一口都是对美好生活的独特礼赞。\\"]",'."\n" + .' "Usage": "{\\"total_tokens\\":200}"'."\n" + .' },'."\n" + .' "State":"Finished",'."\n" + .' "JobId":"******8c784f461db57c99c9d9******",'."\n" + .' "SmartJobInfo":{'."\n" + .' "JobType":"TextGenerate",'."\n" + .' "ModifiedTime":"2024-01-17T08:46:17Z",'."\n" + .' "CreateTime":"2024-01-17T08:46:17Z",'."\n" + .' "Title":"default_title_2024-01-17T08:46:17Z",'."\n" + .' "EditingConfig":"{\\"Type\\":\\"MarketingCopy\\",\\"GenerateConfig\\":\\"{\\\\\\"keywords\\\\\\":\\\\\\"新开店蛋糕，动物奶油\\\\\\",\\\\\\"textLength\\\\\\":100,\\\\\\"targetCount\\\\\\":3}\\"}"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'DeleteSmartJob' => [ + 'summary' => '用户可以根据任务ID删除智能任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务id，多个任务id用英文逗号分割', + 'description' => '任务ID，多个任务ID用英文逗号分割。', + 'type' => 'string', + 'required' => false, + 'example' => '******b48fb04483915d4f2cd8******,******042d5e4db6866f6289d1******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSmartJobResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n</DeleteSmartJobResponse>","errorExample":""}]', + 'title' => '删除智能任务', + ], + 'ListSmartJobs' => [ + 'summary' => '根据用户所给参数，返回所有符合条件的任务列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '当前开始读取的位置', + 'description' => '当前开始读取的位置', + 'type' => 'string', + 'required' => false, + 'example' => '****73f33c91-d59383e8280b****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。最大不超过100。 默认值：10', + 'description' => '本次请求所返回的最大记录条数。'."\n" + ."\n" + .'最大值：100，默认值：10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码。默认值为1。', + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASR' => 'ASR任务', + 'DynamicChart' => '动态图表任务', + 'VideoTranslation' => '视频翻译任务', + 'TextToSpeech' => '智能语音任务', + ], + 'example' => 'ASR', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序参数，默认根据创建时间倒序', + 'description' => '排序参数，默认根据创建时间倒序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreationTime:Asc' => '按照创建时间正序', + 'CreationTime:Desc' => '按照创建时间倒序', + ], + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'JobState', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Finished' => '执行完成', + 'Failed' => '执行失败', + 'Executing' => '任务执行中', + 'Created' => '任务已创建', + ], + 'example' => 'Finished', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', + ], + 'SmartJobList' => [ + 'description' => '智能任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '智能任务', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务Id', + 'description' => '任务Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Title' => [ + 'title' => '任务标题', + 'description' => '任务标题', + 'type' => 'string', + 'example' => '测试标题', + ], + 'Description' => [ + 'title' => '任务描述', + 'description' => '任务描述', + 'type' => 'string', + 'example' => '测试描述', + ], + 'UserId' => [ + 'title' => '用户Id', + 'description' => '用户Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1084506228******', + ], + 'JobType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'ASR' => 'ASR任务', + 'DynamicChart' => '动态图表任务', + 'TextToSpeech' => '智能语音任务', + ], + 'example' => 'ASR', + ], + 'EditingConfig' => [ + 'title' => '输入配置', + 'description' => '输入配置', + 'type' => 'string', + 'example' => '{"AudioConfig":{},"InputConfig":""}', + ], + 'UserData' => [ + 'title' => '用户自定义字段', + 'description' => '用户自定义字段', + 'type' => 'string', + 'example' => '{"user":"data"}', + ], + 'JobState' => [ + 'title' => '任务状态', + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finished' => '执行完成', + 'Failed' => '执行失败', + 'Executing' => '任务执行中', + 'Created' => '任务已创建', + ], + 'example' => 'Finished', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'ModifiedTime' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'InputConfig' => [ + 'title' => '任务输入配置', + 'description' => '任务输入配置', + 'type' => 'object', + 'properties' => [ + 'InputFile' => [ + 'title' => '文件信息', + 'description' => '文件信息', + 'type' => 'string', + 'example' => 'oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4', + ], + 'Keyword' => [ + 'title' => '关键词信息', + 'description' => '关键词信息', + 'type' => 'string', + 'example' => '测试关键词', + ], + ], + ], + 'OutputConfig' => [ + 'title' => '任务输出配置', + 'description' => '任务输出配置', + 'type' => 'object', + 'properties' => [ + 'Bucket' => [ + 'title' => 'OSS Bucket', + 'description' => 'OSS Bucket', + 'type' => 'string', + 'example' => 'test-bucket', + ], + 'Object' => [ + 'title' => 'OSS Object', + 'description' => 'OSS Object', + 'type' => 'string', + 'example' => 'test-object', + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'example' => 'CBB6BC61D08', + ], + 'MaxResults' => [ + 'title' => '本次请求所返回的最大记录条数，最后一页前每页记录条数为MaxResults取值。 例如： 正例：10,10,5，反例：10,5,10', + 'description' => '本次请求所返回的最大记录条数，最后一页前每页记录条数为MaxResults取值。 例如： 正例：10,10,5，反例：10,5,10', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'title' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', + 'type' => 'string', + 'example' => '110', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"SmartJobList\\": [\\n {\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Title\\": \\"测试标题\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"UserId\\": 0,\\n \\"JobType\\": \\"ASR\\",\\n \\"EditingConfig\\": \\"{\\\\\\"AudioConfig\\\\\\":{},\\\\\\"InputConfig\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"UserData\\": \\"{\\\\\\"user\\\\\\":\\\\\\"data\\\\\\"}\\",\\n \\"JobState\\": \\"Finished\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"InputConfig\\": {\\n \\"InputFile\\": \\"oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4\\",\\n \\"Keyword\\": \\"测试关键词\\"\\n },\\n \\"OutputConfig\\": {\\n \\"Bucket\\": \\"test-bucket\\",\\n \\"Object\\": \\"test-object\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"CBB6BC61D08\\",\\n \\"MaxResults\\": \\"10\\",\\n \\"TotalCount\\": \\"110\\"\\n}","errorExample":""},{"type":"xml","example":"<ListSmartJobsResponse>\\n <RequestId>****9262E3DA-07FA-4862-FCBB6BC61D08*****</RequestId>\\n <SmartJobList>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n <Title>测试标题</Title>\\n <Description>测试描述</Description>\\n <JobType>ASR</JobType>\\n <EditingConfig>{\\"AudioConfig\\":{},\\"InputConfig\\":\\"\\"}</EditingConfig>\\n <UserData>{\\"user\\":\\"data\\"}</UserData>\\n <JobState>Finished</JobState>\\n <CreateTime>2020-12-26T04:11:10Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <InputConfig>\\n <InputFile>oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4</InputFile>\\n <Keyword>测试关键词</Keyword>\\n </InputConfig>\\n <OutputConfig>\\n <Bucket>test-bucket</Bucket>\\n <Object>test-object</Object>\\n </OutputConfig>\\n </SmartJobList>\\n <NextToken>CBB6BC61D08</NextToken>\\n <MaxResults>10</MaxResults>\\n <TotalCount>110</TotalCount>\\n</ListSmartJobsResponse>","errorExample":""}]', + 'title' => '获取任务列表', + ], + 'ListSmartSysAvatarModels' => [ + 'summary' => '获取系统数字人列表，支持分页查询。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '172912', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SdkVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'SmartSysAvatarModelList' => [ + 'description' => '数字人信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '数字人信息列表', + 'type' => 'object', + 'properties' => [ + 'AvatarName' => [ + 'description' => '数字人名称', + 'type' => 'string', + 'example' => '云乔', + ], + 'AvatarId' => [ + 'description' => '数字人Id，用于提交单独数字人渲染任务或者智能时间线中使用数字人形象', + 'type' => 'string', + 'example' => 'yunqiao', + ], + 'CoverUrl' => [ + 'description' => '数字人示例封面地址', + 'type' => 'string', + 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4', + ], + 'VideoUrl' => [ + 'description' => '数字人示例视频地址', + 'type' => 'string', + 'example' => 'http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4', + ], + 'Width' => [ + 'description' => '视频分辨率宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'Height' => [ + 'description' => '视频分辨率高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1920', + ], + 'Bitrate' => [ + 'description' => '视频码率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4000', + ], + 'OutputMask' => [ + 'description' => '是否支持渲染人像遮罩。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '虚拟人总数', + 'description' => '系统数字人形象总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"SmartSysAvatarModelList\\": [\\n {\\n \\"AvatarName\\": \\"云乔\\",\\n \\"AvatarId\\": \\"yunqiao\\",\\n \\"CoverUrl\\": \\"http://ice-pub-media.myalicdn.com/smart/avatarModel/coverDemo/yunqiao.mp4\\",\\n \\"VideoUrl\\": \\"http://ice-pub-media.myalicdn.com/smart/avatarModel/videoDemo/yunqiao.mp4\\",\\n \\"Width\\": 1080,\\n \\"Height\\": 1920,\\n \\"Bitrate\\": 4000,\\n \\"OutputMask\\": false\\n }\\n ],\\n \\"TotalCount\\": 4\\n}","type":"json"}]', + 'title' => '获取系统数字人列表', + ], + 'ListSmartVoiceGroups' => [ + 'summary' => '列出智能语音发音人信息，包括发音人名称、性别、示例音频，列表按照场景进行分组。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147883', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'VoiceType', + 'in' => 'query', + 'schema' => [ + 'title' => '音色类型，默认不填：返回小模型语种音色。支持传入：'."\n" + .'Cosyvoice，返回Cosyvoice大模型音色示例。', + 'description' => '音色类型，默认不填时：返回小模型语种音色。支持传入：'."\n" + .'Cosyvoice，返回Cosyvoice大模型音色示例。', + 'type' => 'string', + 'required' => false, + 'example' => 'CosyVoice', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '627B30EB-1D0A-5C6D-8467-431626E0FA10', + ], + 'VoiceGroups' => [ + 'description' => '发音人组结果集', + 'type' => 'array', + 'items' => [ + 'description' => '发音人组', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '发音人组名称', + 'type' => 'string', + 'example' => '超高清', + ], + 'VoiceList' => [ + 'description' => '发音人列表', + 'type' => 'array', + 'items' => [ + 'description' => '发音人', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '发音人名称', + 'type' => 'string', + 'example' => '知甜', + ], + 'VoiceType' => [ + 'description' => '发音人类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Male' => '男性', + 'Female' => '女性', + 'Boy' => '男孩', + 'Girl' => '女孩', + ], + 'example' => 'Female', + ], + 'Voice' => [ + 'description' => '发音人id', + 'type' => 'string', + 'example' => 'zhitian', + ], + 'Desc' => [ + 'description' => '发音人描述', + 'type' => 'string', + 'example' => '甜美女声', + ], + 'Tag' => [ + 'description' => '发音人类型标签', + 'type' => 'string', + 'example' => '通用场景', + ], + 'Remark' => [ + 'description' => '发音人备注', + 'type' => 'string', + 'example' => '中文及中英文混合场景', + ], + 'VoiceUrl' => [ + 'description' => '发音人示例音频', + 'type' => 'string', + 'example' => 'https://***.com/zhitian.mp3', + ], + 'SupportSampleRate' => [ + 'description' => '当前音色支持的采样率信息', + 'type' => 'string', + 'example' => '48000', + ], + 'VoiceSource' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"627B30EB-1D0A-5C6D-8467-431626E0FA10\\",\\n \\"VoiceGroups\\": [\\n {\\n \\"Type\\": \\"超高清\\",\\n \\"VoiceList\\": [\\n {\\n \\"Name\\": \\"知甜\\",\\n \\"VoiceType\\": \\"Female\\",\\n \\"Voice\\": \\"zhitian\\",\\n \\"Desc\\": \\"甜美女声\\",\\n \\"Tag\\": \\"通用场景\\",\\n \\"Remark\\": \\"中文及中英文混合场景\\",\\n \\"VoiceUrl\\": \\"https://***.com/zhitian.mp3\\",\\n \\"SupportSampleRate\\": \\"48000\\",\\n \\"VoiceSource\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列出智能语音发音人信息', + ], + 'StartAIAgentInstance' => [ + 'summary' => '启动一个IMS配置的AI智能体实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236525', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '[IMS控制台](https://ims.console.aliyun.com/ai/robot/list)上配置的智能体ID。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'RuntimeConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '智能体运行时所需要的配置。', + 'required' => true, + '$ref' => '#/components/schemas/AIAgentRuntimeConfig', + ], + ], + [ + 'name' => 'AgentConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '智能体模版配置，填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。'."\n" + ."\n" + .'> 兼容TemplateConfig规则：优先使用AgentConfig中的字段，如果TemplateConfig存在某些字段AgentConfig未填写，会使用TemplateConfig字段。推荐使用AgentConfig，不再使用TemplateConfig。', + 'required' => false, + '$ref' => '#/components/schemas/AIAgentConfig', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Email":"[email protected]","Preferences":{"Language":"en"}}', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话的唯一标记，默认无。', + 'type' => 'string', + 'required' => false, + 'example' => 'f213fbc005e4f309379701645f4****'."\n", + ], + ], + [ + 'name' => 'ChatSyncConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '同步聊天记录配置。', + 'type' => 'object', + 'properties' => [ + 'IMAIAgentId' => [ + 'description' => 'IM的智能体Id。', + 'type' => 'string', + 'required' => false, + 'example' => '******005e4f309379701645f4****'."\n", + ], + 'ReceiverId' => [ + 'description' => '接收用户Id。', + 'type' => 'string', + 'required' => false, + 'example' => '4167626d312034b2b1c3b7f2f3e41884', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '智能体模版配置，填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。'."\n" + ."\n" + .'> 智能体模版配置。已废弃，详见AgentConfig字段。', + 'deprecated' => true, + 'required' => false, + '$ref' => '#/components/schemas/AIAgentTemplateConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + 'InstanceId' => [ + 'description' => '该智能体实例的唯一ID', + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\"\\n}","type":"json"}]', + 'title' => '启动智能体实例', + 'description' => '通过此API，您可以启动一个配置好的AI智能体实例，并让它参与到某个对话中去。您需要提供智能体的ID（`AIAgentId`）、运行时配置（`RuntimeConfig`），可选的包括模版配置（`TemplateConfig`）及用户自定义信息（`UserData`）。智能体实例一旦成功启动，将返回唯一的`InstanceId`用于后续跟踪或操作。', + ], + 'StopAIAgentInstance' => [ + 'summary' => '停止一个智能体实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236519', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例ID。'."\n" + ."\n\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '成功响应时返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '停止智能体实例', + 'description' => '- **功能描述**：此接口用于停止并终止一个正在运行中的智能体实例，释放相关资源。'."\n" + .'- **参数注意**：需要提供待停止实例的唯一ID（InstanceId）作为查询参数。'."\n" + .'- **应用场景**：当不再需要某个智能体参与通话或任务时，可调用此接口结束其运行。', + ], + 'UpdateAIAgentInstance' => [ + 'summary' => '修改指定AI智能体实例的配置信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236521', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'AgentConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要更新的智能体配置，和实例启动所使用的配置进行合并更新。详见 AIAgentConfig 定义。 支持更新 AIAgentTemplateConfig 中的以下参数：'."\n" + ."\n" + .'- VoiceId'."\n" + ."\n" + .'- EnableVoiceInterrupt'."\n" + .'- Greeting'."\n" + ."\n" + .'- Volume'."\n" + ."\n" + .'- EnablePushToTalk'."\n" + .'- UseVoiceprint'."\n" + ."\n" + .'- BailianAppParams', + 'required' => false, + '$ref' => '#/components/schemas/AIAgentConfig', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"VoiceId":"xiaoxia"}', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '> 智能体模版配置。已废弃，请使用AgentConfig字段。'."\n" + ."\n" + .'需要更新的智能体配置，和实例启动所使用的配置进行合并更新。详见[AIAgentTemplateConfig](~~2846193~~)定义。'."\n" + .'支持更新AIAgentTemplateConfig中的以下参数：'."\n" + ."\n" + .'- VoiceId（语音ID）'."\n" + ."\n" + .'- EnableVoiceInterrupt（启用语音打断）'."\n" + ."\n" + .'- Greeting（问候语）'."\n" + ."\n" + .'- Volume（音量）'."\n" + ."\n" + .'- EnablePushToTalk（启用按键通话）'."\n" + ."\n" + .'- UseVoiceprint（使用声纹）'."\n" + ."\n" + .'- AsrMaxSilence（ASR最大静音时间）', + 'deprecated' => true, + 'required' => false, + '$ref' => '#/components/schemas/AIAgentTemplateConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '更新AI智能体实例配置', + 'description' => '允许输入智能体实例Id和配置来更新智能体的配置（比如音色等）。', + ], + 'DescribeAIAgentInstance' => [ + 'summary' => '查询实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236522', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Instance' => [ + 'description' => '智能体实例信息', + 'type' => 'object', + 'properties' => [ + 'CallLogUrl' => [ + 'description' => '通话日志的URL。', + 'type' => 'string', + 'example' => 'https://example.com/call_logs/12345', + ], + 'RuntimeConfig' => [ + 'description' => '智能体运行时的配置信息。', + 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', + '$ref' => '#/components/schemas/AIAgentRuntimeConfig', + ], + 'Status' => [ + 'description' => '智能体实例的状态，如Finished，Executing。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finished' => '结束', + 'Executing' => '运行中', + ], + 'example' => 'Finished', + ], + 'TemplateConfig' => [ + 'description' => '智能体模版配置。', + 'deprecated' => true, + 'example' => '{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}', + '$ref' => '#/components/schemas/AIAgentTemplateConfig', + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"Email":"[email protected]","Preferences":{"Language":"en"}}', + ], + 'SessionId' => [ + 'description' => '对话的唯一标记，默认无。', + 'type' => 'string', + 'example' => '955535**************', + ], + 'AgentConfig' => [ + 'description' => '智能体模版配置。', + '$ref' => '#/components/schemas/AIAgentConfig', + ], + 'GmtCreate' => [ + 'description' => '创建时间(UTC)', + 'type' => 'string', + 'example' => '2025-07-18T06:39:08.000+00:00', + ], + 'GmtModified' => [ + 'description' => '修改时间(UTC)', + 'type' => 'string', + 'example' => '2025-07-18T06:40:12.000+00:00', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instance\\": {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345\\",\\n \\"RuntimeConfig\\": {\\n \\"VoiceChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"VisionChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"ChannelId\\": \\"\\",\\n \\"AvatarChat3D\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n }\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"VoiceChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AvatarUrlType\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"MessageChat\\": {\\n \\"AppId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"AvatarChat3D\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"AvatarId\\": \\"\\",\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"[email protected]\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"SessionId\\": \\"955535**************\\",\\n \\"AgentConfig\\": {\\n \\"AppId\\": \\"\\",\\n \\"Greeting\\": \\"\\",\\n \\"WakeUpQuery\\": \\"\\",\\n \\"MaxIdleTime\\": 0,\\n \\"UserOnlineTimeout\\": 0,\\n \\"UserOfflineTimeout\\": 0,\\n \\"EnablePushToTalk\\": true,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 0,\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"AvatarUrlType\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"\\",\\n \\"AsrMaxSilence\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CustomParams\\": \\"\\",\\n \\"VadDuration\\": 0\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"\\",\\n \\"Pronunciation\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"ModelId\\": \\"\\",\\n \\"LanguageId\\": \\"\\",\\n \\"Emotion\\": \\"\\",\\n \\"SpeechRate\\": 0\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"OpenAIExtraQuery\\": \\"\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"\\",\\n \\"MatchFunction\\": \\"\\"\\n }\\n ],\\n \\"OutputMinLength\\": 0,\\n \\"OutputMaxDelay\\": 0,\\n \\"HistorySyncWithTTS\\": true\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"NoInterruptMode\\": \\"\\"\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"RegistrationMode\\": \\"\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"\\",\\n \\"SemanticWaitDuration\\": 0,\\n \\"Eagerness\\": \\"\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": true\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": true\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": true\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"OutboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"SipDomain\\": \\"\\"\\n },\\n \\"InboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"AuthUrl\\": \\"\\",\\n \\"AuthToken\\": \\"\\"\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"\\",\\n \\"Volume\\": 0\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 0,\\n \\"MaxRepeats\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ]\\n },\\n \\"GmtCreate\\": \\"2025-07-18T06:39:08.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-18T06:40:12.000+00:00\\"\\n },\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '查询智能体实例详情', + 'description' => '- **功能描述**：此接口用于查询指定智能体实例的详细信息。'."\n" + .'- **使用场景**：当需要监控或分析智能体在通话中的表现，或者调试智能体配置效果时，可调用此接口获取所需数据。', + ], + 'ListAIAgentInstance' => [ + 'summary' => '查询AI智能体实例列表，可以获取所有或指定条件下的智能体实例列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236523', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体Id。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4***', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间（ISO 8601 格式）。默认无。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间（ISO 8601 格式）。默认无。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-02T00:00:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量，默认10，取值范围0~100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页数，默认值1，取值范围1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Instances' => [ + 'description' => '智能体实例结构体列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallLogUrl' => [ + 'description' => '智能体对话通话记录文件URL，该文件内部是CallLog结构（Json格式）。', + 'type' => 'string', + 'example' => 'https://example.com/call_logs/12345.json', + ], + 'RuntimeConfig' => [ + 'description' => '智能体运行时所需要的配置。', + 'example' => '{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}', + '$ref' => '#/components/schemas/AIAgentRuntimeConfig', + ], + 'Status' => [ + 'description' => '实例状态：'."\n" + ."\n" + .'- Created：通话启动但是双端未建立连接'."\n" + ."\n" + .'- Executing：通话执行中，双端已经建立连接'."\n" + ."\n" + .'- Finished：通话结束', + 'type' => 'string', + 'enumValueTitles' => [ + 'Finished' => 'Finished', + 'Executing' => 'Executing', + ], + 'example' => 'Finished', + ], + 'TemplateConfig' => [ + 'description' => '智能体实例所使用的模版配置。', + 'deprecated' => true, + 'example' => '{"VoiceChat": {"VoiceId": "zhixiaoxia"}}', + '$ref' => '#/components/schemas/AIAgentTemplateConfig', + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"Email":"[email protected]","Preferences":{"Language":"en"}}', + ], + 'AgentConfig' => [ + 'description' => '智能体实例所使用的模版配置。', + '$ref' => '#/components/schemas/AIAgentConfig', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"CallLogUrl\\": \\"https://example.com/call_logs/12345.json\\",\\n \\"RuntimeConfig\\": {\\n \\"VoiceChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"VisionChat\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n },\\n \\"ChannelId\\": \\"\\",\\n \\"AvatarChat3D\\": {\\n \\"AuthToken\\": \\"\\",\\n \\"AgentUserId\\": \\"\\",\\n \\"ChannelId\\": \\"\\"\\n }\\n },\\n \\"Status\\": \\"Finished\\",\\n \\"TemplateConfig\\": {\\n \\"VoiceChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AvatarUrlType\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"MessageChat\\": {\\n \\"AppId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ]\\n },\\n \\"VisionChat\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n },\\n \\"AvatarChat3D\\": {\\n \\"Greeting\\": \\"\\",\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"AvatarId\\": \\"\\",\\n \\"CharBreak\\": true,\\n \\"EnableVoiceInterrupt\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"GracefulShutdown\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"UserOnlineTimeout\\": 0,\\n \\"AsrLanguageId\\": \\"\\",\\n \\"UserOfflineTimeout\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"VadLevel\\": 0,\\n \\"LlmHistoryLimit\\": 0,\\n \\"AsrMaxSilence\\": 0,\\n \\"WakeUpQuery\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"Volume\\": 0,\\n \\"VoiceId\\": \\"\\",\\n \\"UseVoiceprint\\": true,\\n \\"MaxIdleTime\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"EnablePushToTalk\\": true\\n }\\n },\\n \\"UserData\\": \\"{\\\\\\"Email\\\\\\":\\\\\\"[email protected]\\\\\\",\\\\\\"Preferences\\\\\\":{\\\\\\"Language\\\\\\":\\\\\\"en\\\\\\"}}\\",\\n \\"AgentConfig\\": {\\n \\"AppId\\": \\"\\",\\n \\"Greeting\\": \\"\\",\\n \\"WakeUpQuery\\": \\"\\",\\n \\"MaxIdleTime\\": 0,\\n \\"UserOnlineTimeout\\": 0,\\n \\"UserOfflineTimeout\\": 0,\\n \\"EnablePushToTalk\\": true,\\n \\"GracefulShutdown\\": true,\\n \\"Volume\\": 0,\\n \\"WorkflowOverrideParams\\": \\"\\",\\n \\"AvatarUrl\\": \\"\\",\\n \\"AvatarUrlType\\": \\"\\",\\n \\"EnableIntelligentSegment\\": true,\\n \\"AsrConfig\\": {\\n \\"AsrLanguageId\\": \\"\\",\\n \\"AsrMaxSilence\\": 0,\\n \\"AsrHotWords\\": [\\n \\"\\"\\n ],\\n \\"VadLevel\\": 0,\\n \\"CustomParams\\": \\"\\",\\n \\"VadDuration\\": 0\\n },\\n \\"TtsConfig\\": {\\n \\"VoiceId\\": \\"\\",\\n \\"VoiceIdList\\": [\\n \\"\\"\\n ],\\n \\"PronunciationRules\\": [\\n {\\n \\"Word\\": \\"\\",\\n \\"Pronunciation\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ],\\n \\"ModelId\\": \\"\\",\\n \\"LanguageId\\": \\"\\",\\n \\"Emotion\\": \\"\\",\\n \\"SpeechRate\\": 0\\n },\\n \\"LlmConfig\\": {\\n \\"LlmHistory\\": [\\n {\\n \\"Role\\": \\"\\",\\n \\"Content\\": \\"\\"\\n }\\n ],\\n \\"LlmHistoryLimit\\": 0,\\n \\"LlmSystemPrompt\\": \\"\\",\\n \\"BailianAppParams\\": \\"\\",\\n \\"OpenAIExtraQuery\\": \\"\\",\\n \\"LlmCompleteReply\\": true,\\n \\"FunctionMap\\": [\\n {\\n \\"Function\\": \\"\\",\\n \\"MatchFunction\\": \\"\\"\\n }\\n ],\\n \\"OutputMinLength\\": 0,\\n \\"OutputMaxDelay\\": 0,\\n \\"HistorySyncWithTTS\\": true\\n },\\n \\"AvatarConfig\\": {\\n \\"AvatarId\\": \\"\\"\\n },\\n \\"InterruptConfig\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"InterruptWords\\": [\\n \\"\\"\\n ],\\n \\"NoInterruptMode\\": \\"\\"\\n },\\n \\"VoiceprintConfig\\": {\\n \\"UseVoiceprint\\": true,\\n \\"VoiceprintId\\": \\"\\",\\n \\"RegistrationMode\\": \\"\\"\\n },\\n \\"TurnDetectionConfig\\": {\\n \\"TurnEndWords\\": [\\n \\"\\"\\n ],\\n \\"Mode\\": \\"\\",\\n \\"SemanticWaitDuration\\": 0,\\n \\"Eagerness\\": \\"\\"\\n },\\n \\"ExperimentalConfig\\": \\"\\",\\n \\"VcrConfig\\": {\\n \\"StillFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"InvalidFrameMotion\\": {\\n \\"Enabled\\": true,\\n \\"CallbackDelay\\": 0\\n },\\n \\"PeopleCount\\": {\\n \\"Enabled\\": true\\n },\\n \\"Equipment\\": {\\n \\"Enabled\\": true\\n },\\n \\"HeadMotion\\": {\\n \\"Enabled\\": true\\n },\\n \\"LookAway\\": {\\n \\"Enabled\\": true\\n }\\n },\\n \\"OutboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"SipDomain\\": \\"\\"\\n },\\n \\"InboundCallConfig\\": {\\n \\"Type\\": 0,\\n \\"AuthUrl\\": \\"\\",\\n \\"AuthToken\\": \\"\\"\\n },\\n \\"AmbientSoundConfig\\": {\\n \\"ResourceId\\": \\"\\",\\n \\"Volume\\": 0\\n },\\n \\"AutoSpeechConfig\\": {\\n \\"UserIdle\\": {\\n \\"WaitTime\\": 0,\\n \\"MaxRepeats\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n },\\n \\"LlmPending\\": {\\n \\"WaitTime\\": 0,\\n \\"Messages\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n },\\n \\"BackChannelingConfigs\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ],\\n \\"BackChannelingConfig\\": [\\n {\\n \\"Enabled\\": true,\\n \\"TriggerStage\\": \\"\\",\\n \\"Probability\\": 0,\\n \\"Words\\": [\\n {\\n \\"Text\\": \\"\\",\\n \\"Probability\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '查询AI智能体实例列表', + 'description' => '该接口允许用户根据指定的智能体ID（`AIAgentId`），以及可选的时间范围（`StartTime` 和 `EndTime`）、每页记录数（`PageSize`）和当前页码（`PageNumber`）来查询AI智能体实例列表。返回结果包含每个实例的状态、运行时配置、模板配置、用户自定义数据及对话通话记录的下载链接。'."\n" + ."\n" + .'><notice>分页参数默认值：PageSize 为 10，PageNumber 为 1。></notice>', + ], + 'SendAIAgentSpeech' => [ + 'summary' => '让指定智能体实例立即播报文本消息，支持打断设置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => '需要播报的文本内容。根据不同Type支持不同的输入类型。长度不超过1024。', + 'type' => 'string', + 'required' => true, + 'example' => '你好，欢迎使用我们的服务', + ], + ], + [ + 'name' => 'EnableInterrupt', + 'in' => 'query', + 'schema' => [ + 'description' => '这条主动播报是否能打断当前语音。默认值：true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '输入类型，可选：'."\n" + ."\n" + .'- Text：传入类型文本'."\n" + ."\n" + .'- AudioUrl：传入类型为音频链接'."\n" + ."\n" + .'默认Text。', + 'type' => 'string', + 'required' => false, + 'example' => 'Text', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '发送AI智能体语音', + 'description' => '使用此接口可以立即指令一个AI智能体实例进行语音播报，传入指定的文本内容。用户可选择性地允许此次播报中断当前正在进行的语音播放，默认为允许打断。'."\n" + ."\n" + .'**注意：**'."\n" + .'- `InstanceId` 必须有效且对应一个存在的智能体实例。'."\n" + .'- `Text` 的内容应符合规范，避免包含敏感或不当信息。'."\n" + .'- 若不希望新播报打断当前语音，需明确设置 `EnableInterrupt` 为 `false`。', + ], + 'TakeoverAIAgentCall' => [ + 'summary' => '切换真人客服接管模式。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例 ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'HumanAgentUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '将要接管的真人客服的 RTC UserId。不填写则自动生成并返回。', + 'type' => 'string', + 'required' => false, + 'example' => 'uid2', + ], + ], + [ + 'name' => 'RequireToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回RTC入会Token，默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'ChannelId' => [ + 'description' => 'ARTC 频道 ID。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208', + ], + 'HumanAgentUserId' => [ + 'description' => '真人入会uid。', + 'type' => 'string', + 'example' => 'uid2', + ], + 'Token' => [ + 'description' => '真人入会rtc token。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\",\\n \\"HumanAgentUserId\\": \\"uid2\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\"\\n}","type":"json"}]', + 'title' => '开启真人接管模式', + ], + 'SendAIAgentDataChannelMessage' => [ + 'summary' => '向智能体通话发送DataChannel消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前正在通话的智能体实例ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****'."\n", + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '需要发送的datachannel消息。需要传入JSON字符串。字符串长度不超过8192。', + 'type' => 'string', + 'required' => true, + 'example' => '{"key":"value"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\\\n\\"\\n}","type":"json"}]', + 'title' => '向智能体通话发送DataChannel消息', + ], + 'SendAIAgentText' => [ + 'summary' => '传入消息作为LLM输入。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体实例ID。'."\n" + ."\n" + .'> InstanceId为智能体实例启动成功后，返回的唯一的Id。启动智能体接口，请参见[StartAIAgentInstance ](~~2846201~~)、[GenerateAIAgentCall](~~2846209~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'f27f9b9be28642a88e18****', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => '传给LLM的文本。', + 'type' => 'string', + 'required' => true, + 'example' => '你好。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DB488837-3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB488837-3****\\"\\n}","type":"json"}]', + 'title' => '传入消息作为LLM输入', + ], + 'GenerateMessageChatToken' => [ + 'summary' => '生成直播互动消息所需的token。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236523', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '19de81b3b3d94abda22******', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '要登录的用户的 ID。 仅限 A-Z,a-z,0-9 及"_"，最长 64 字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'YOURUSERID', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '角色，为 admin 时，表示该用户可以调用“管控类”接口。默认空。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => [ + 'description' => '超时时间，单位秒，默认 3600 秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'req_1234567890abcdef', + ], + 'Token' => [ + 'description' => '生成的 Token。', + 'type' => 'string', + 'example' => 'acet**********', + ], + 'AppId' => [ + 'description' => '用户的 AppID。', + 'type' => 'string', + 'example' => '***********', + ], + 'UserId' => [ + 'description' => '用户入会的 UserId。', + 'type' => 'string', + 'example' => 'YOURUSERID', + ], + 'Nonce' => [ + 'description' => '生成 Token 所用的 Nonce。', + 'type' => 'string', + 'example' => 'AK-***********', + ], + 'Role' => [ + 'description' => '生成 Token 所用的角色。', + 'type' => 'string', + 'example' => 'admin', + ], + 'AppSign' => [ + 'description' => '应用 AppSign。', + 'type' => 'string', + 'example' => 'H4sIAAAAAAAE******************', + ], + 'TimeStamp' => [ + 'description' => '过期时间，过期时间 = 当前时间+过期时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700000000', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"req_1234567890abcdef\\",\\n \\"Token\\": \\"acet**********\\",\\n \\"AppId\\": \\"***********\\",\\n \\"UserId\\": \\"YOURUSERID\\",\\n \\"Nonce\\": \\"AK-***********\\",\\n \\"Role\\": \\"admin\\",\\n \\"AppSign\\": \\"H4sIAAAAAAAE******************\\",\\n \\"TimeStamp\\": 1700000000\\n}","type":"json"}]', + 'title' => '生成直播互动消息所需的token', + ], + 'GenerateAIAgentCall' => [ + 'summary' => '创建一个智能体实例，返回智能体所在的频道、频道内名称以及进入频道所需的token。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体ID。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => [ + 'description' => '可选参数，表示token失效的时间，单位秒，默认3600秒。取值范围0~604800。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话频道内用户名称，不输入则系统自动生成。长度不超过64。', + 'type' => 'string', + 'required' => false, + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '- 填写的配置会和控制台上的智能体模版配置进行合并更新。'."\n" + ."\n" + .'- 不填写则使用控制台上智能体的默认配置。'."\n" + ."\n" + .'> 智能体模版配置。已废弃，详见AgentConfig字段。', + 'deprecated' => true, + 'required' => false, + '$ref' => '#/components/schemas/AIAgentTemplateConfig', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Email":"[email protected]","Preferences":{"Language":"en"}}'."\n", + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话的唯一标记，默认无。', + 'type' => 'string', + 'required' => false, + 'example' => 'fw1gr0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'AgentConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '智能体模版配置，填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。'."\n" + ."\n" + .'> 兼容TemplateConfig规则：优先使用AgentConfig中的字段，如果TemplateConfig存在某些字段AgentConfig未填写，会使用TemplateConfig字段。推荐使用AgentConfig，不再使用TemplateConfig。', + 'required' => false, + '$ref' => '#/components/schemas/AIAgentConfig', + ], + ], + [ + 'name' => 'ChatSyncConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '同步聊天记录配置。', + 'type' => 'object', + 'properties' => [ + 'IMAIAgentId' => [ + 'description' => 'IM的智能体Id。', + 'type' => 'string', + 'required' => false, + 'example' => '******005e4f309379701645f4****'."\n", + ], + 'ReceiverId' => [ + 'description' => '接收用户Id。', + 'type' => 'string', + 'required' => false, + 'example' => '4167626d312034b2b1c3b7f2f3e41884', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AIAgentUserId' => [ + 'description' => 'ARTC频道内智能体的名称。', + 'type' => 'string', + 'example' => '877ae632caae49b1afc81c2e8194ffb4', + ], + 'ChannelId' => [ + 'description' => 'ARTC频道ID。', + 'type' => 'string', + 'example' => '70f22d5784194938a7e387052f2b3208', + ], + 'InstanceId' => [ + 'description' => '生成的智能体实例ID。', + 'type' => 'string', + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + 'Token' => [ + 'description' => '端侧的ARTC Token。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'UserId' => [ + 'description' => 'ARTC频道内用户名称。', + 'type' => 'string', + 'example' => 'user123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AIAgentUserId\\": \\"877ae632caae49b1afc81c2e8194ffb4\\",\\n \\"ChannelId\\": \\"70f22d5784194938a7e387052f2b3208\\",\\n \\"InstanceId\\": \\"39f8e0bc005e4f309379701645f4****\\",\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"UserId\\": \\"user123\\"\\n}","type":"json"}]', + 'title' => '生成AI智能体通话实例', + 'description' => '通过此API，您可以根据提供的AI智能体ID（AIAgentId）创建一个智能体实例。您可以通过API响应中的信息进入对应房间，与智能体进行对话。'."\n" + ."\n" + .'><notice>确保提供的AI智能体ID有效，并根据实际应用场景适当配置可选参数。></notice>', + ], + 'ListAIAgentDialogues' => [ + 'summary' => '列出会话的历史记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235498', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f27f9b9be28642a88e18****', + ], + ], + [ + 'name' => 'RoundLimit', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始Unix时间戳（包含），毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束Unix时间戳（包含），毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '17358082464030', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页数，默认1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，最大100，默认20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'ASC正序，DESC倒序。默认DESC。', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B117AF5-***************', + ], + 'Dialogues' => [ + 'description' => '对话记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DialogueId' => [ + 'description' => '这条对话的唯一ID。', + 'type' => 'string', + 'example' => '19de81b3b3d94abda22****', + ], + 'RoundId' => [ + 'description' => '对话回合ID。', + 'type' => 'string', + 'example' => 'f27f9b9be28642a88e18****', + ], + 'Producer' => [ + 'description' => '这句话的产生者。'."\n" + ."\n" + .'- user： 用户产生的句子'."\n" + ."\n" + .'- agent：智能体产生的句子。', + 'type' => 'string', + 'enumValueTitles' => [ + 'agent' => 'agent', + 'user' => 'user', + ], + 'example' => 'user', + ], + 'Text' => [ + 'description' => '对话具体的文本。', + 'type' => 'string', + 'example' => '你好', + ], + 'ReasoningText' => [ + 'description' => '深度思考的文本。', + 'type' => 'string', + 'example' => '我在思考', + ], + 'AttachedFileList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Format' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Time' => [ + 'description' => '这条对话产生的Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734511087000', + ], + 'Type' => [ + 'description' => '这句话的类型。可选：'."\n" + ."\n" + .'语音通话'."\n" + .'1. greeting 欢迎语'."\n" + .'2. normal 语音回复'."\n" + .'3. speech 主动播报'."\n" + ."\n" + .'文本对话'."\n" + .'1. normal 文本回复'."\n" + .'2. announcement 主动推送文字。'."\n" + .'3. custom 自定义消息。', + 'type' => 'string', + 'example' => 'announcement', + ], + 'Source' => [ + 'description' => '这句话的来源。可选：'."\n" + ."\n" + .'chat 文本对话'."\n" + ."\n" + .'call 语音通话', + 'type' => 'string', + 'example' => 'chat', + ], + 'NodeId' => [ + 'type' => 'string', + ], + 'Extend' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-***************\\",\\n \\"Dialogues\\": [\\n {\\n \\"DialogueId\\": \\"19de81b3b3d94abda22****\\",\\n \\"RoundId\\": \\"f27f9b9be28642a88e18****\\",\\n \\"Producer\\": \\"user\\",\\n \\"Text\\": \\"你好\\",\\n \\"ReasoningText\\": \\"我在思考\\",\\n \\"AttachedFileList\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Id\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"Type\\": 0,\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Time\\": 1734511087000,\\n \\"Type\\": \\"announcement\\",\\n \\"Source\\": \\"chat\\",\\n \\"NodeId\\": \\"\\",\\n \\"Extend\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询对话记录', + ], + 'DeleteAIAgentDialogue' => [ + 'summary' => '删除智能体的对话历史记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235498', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6d594e7f55624c47a48789******', + ], + ], + [ + 'name' => 'DialogueId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的对话ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f27f9b9be28642a88e18*******', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id。', + 'type' => 'string', + 'example' => '7B117AF5-2A1******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A1******\\"\\n}","type":"json"}]', + 'title' => '删除智能体的对话历史记录', + ], + 'SendMessageChatText' => [ + 'summary' => '向IM客户端发送消息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237311', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话id。', + 'type' => 'string', + 'required' => true, + 'example' => 'f27f9b9be28642a88e18****', + ], + ], + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体Id。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'ReceiverId', + 'in' => 'query', + 'schema' => [ + 'description' => '接收消息的用户ID，由大小写字母、数字组成，长度不超过64字节。', + 'type' => 'string', + 'required' => true, + 'example' => '60000042053', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '发送的消息类型。'."\n" + .'可选：'."\n" + ."\n" + .'- announcement 主动通知文本'."\n" + ."\n" + .'- custom 自定义消息', + 'type' => 'string', + 'required' => true, + 'example' => 'announcement', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => '发送的文本内容。', + 'type' => 'string', + 'required' => true, + 'example' => '你好。', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '发送的方式。可选：'."\n" + ."\n" + .'- online 在线消息。'."\n" + ."\n" + .'- offline 离线消息。'."\n" + .'默认offline。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + ], + [ + 'name' => 'NeedArchiving', + 'in' => 'query', + 'schema' => [ + 'description' => '是否归档聊天记录。'."\n" + .'默认true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '向IM客户端发送消息', + ], + 'StartAIAgentOutboundCall' => [ + 'summary' => '开启一个智能体外呼通话，使用主叫电话呼叫被叫电话，返回通话的InstanceId。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '[IMS控制台](https://ims.console.aliyun.com/ai/robot/list)上配置的智能体ID。', + 'type' => 'string', + 'required' => true, + 'example' => '***********e4f309379701645f4****', + ], + ], + [ + 'name' => 'CallerNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '主叫号码。仅支持中国内地号码。', + 'type' => 'string', + 'required' => true, + 'example' => '183*****333', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '被叫号码。', + 'type' => 'string', + 'required' => true, + 'example' => '173*****533', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '智能体外呼配置。', + 'required' => false, + '$ref' => '#/components/schemas/AIAgentOutboundCallConfig', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义消息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"city":"杭州"}', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '对话的唯一标记，可以用于存储、查询、同步多个通话之间的聊天记录。默认无。', + 'type' => 'string', + 'required' => false, + 'example' => 'f213fbc005e4f309379701645f4****'."\n", + ], + ], + [ + 'name' => 'ImsAIAgentFreeObCall', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '通话实例Id', + 'type' => 'string', + 'example' => '*********296014bb58670940*********', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '***********-4417-BDB2************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"*********296014bb58670940*********\\",\\n \\"RequestId\\": \\"***********-4417-BDB2************\\"\\n}","type":"json"}]', + 'title' => '启动智能体外呼电话', + 'description' => '通过此API，您可以启动一个配置好的AI智能体实例，并让它外呼到传入的被叫电话。智能体实例一旦成功启动，将返回唯一的`InstanceId`用于后续跟踪或操作。每个主叫电话**只支持15路并发**。', + ], + 'ListAIAgentPhoneNumber' => [ + 'summary' => '罗列用户电话资源接口。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236523', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为50，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码，填写Number直接查询对应号码。', + 'type' => 'string', + 'required' => false, + 'example' => '139xxxxxxxxx', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的目标号码的状态。'."\n" + ."\n" + .'- 1: "开通处理中"。'."\n" + ."\n" + .'- 2: "正常"。'."\n" + .' '."\n" + .'- 3: "注销中"。'."\n" + ."\n" + .'- 4: "已注销"。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据数组', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => '电话号码。', + 'type' => 'string', + 'example' => '132*****683', + ], + 'Status' => [ + 'description' => '号码状态。'."\n" + ."\n" + .'- 1: "开通处理中"。'."\n" + ."\n" + .'- 2: "正常"。'."\n" + ."\n" + .'- 3: "注销中"。'."\n" + ."\n" + .'- 4: "已注销"。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '************16-412C-B127-******', + ], + 'TotalNumber' => [ + 'description' => '查询到的电话总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '186', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => ' 每页返回的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"PhoneNumber\\": \\"132*****683\\",\\n \\"Status\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"************16-412C-B127-******\\",\\n \\"TotalNumber\\": 186,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '罗列用户电话资源', + 'description' => '该接口允许用户根据每页记录数（`PageSize`）和当前页码（`PageNumber`）来查询用户电话资源。返回结果包含电话号码和对应状态。', + ], + 'ForwardAIAgentCall' => [ + 'summary' => '转呼通话到目标电话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前通话实例ID,仅在呼入转接场景中使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'call_instance_202******', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '转接呼叫的目标电话号码。', + 'type' => 'string', + 'required' => false, + 'example' => '13**********', + ], + ], + [ + 'name' => 'TransferPrompt', + 'in' => 'query', + 'schema' => [ + 'description' => '转接开始前播放的提示语文本，为空则跳过提示直接播放铃声。默认空。', + 'type' => 'string', + 'required' => false, + 'example' => 'Please hold while I transfer your call.', + ], + ], + [ + 'name' => 'ErrorPrompt', + 'in' => 'query', + 'schema' => [ + 'description' => '转接失败时播放的异常提示文本。默认空。', + 'type' => 'string', + 'required' => false, + 'example' => 'We’re sorry, we’re unable to transfer your call at the moment. Please try again later.'."\n", + ], + ], + [ + 'name' => 'CallerNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '转接呼叫的主叫电话。非必填。'."\n" + ."\n\n" + .'<notice>'."\n" + .'默认CallerNumber为启动电话后，智能体的电话号码:1. 呼入线路，智能体号码为坐席号码。2. 呼出线路，智能体号码为主叫号码。</notice>'."\n" + .'<warning>阿里云线路不支持传入此参数。</warning>', + 'type' => 'string', + 'required' => false, + 'example' => '13**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '550e8400********55440000'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\\\n\\"\\n}","type":"json"}]', + 'title' => '通话转呼接口', + ], + 'SetAIAgentVoiceprint' => [ + 'summary' => '设置声纹', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'VoiceprintId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于唯一标识一个声纹的身份标识。用户需根据自身业务规则生成该ID。字符长度：1-127。', + 'type' => 'string', + 'required' => false, + 'example' => 'vp_1699123456_8527', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入媒体。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '指定音频媒体的访问类型。系统会通过 HEAD/GET 请求验证文件可访问性。可选：'."\n" + ."\n" + .'- url：音频文件的http链接'."\n" + .'- oss: 阿里云 OSS 对象存储方式,支持以下格式:'."\n" + .' 1. OSS URI格式: oss://bucket-name/object-key'."\n" + ."\n" + .' 示例: oss://my-bucket/audio/sample.wav'."\n" + .' '."\n" + .' 2. OSS 外网地址: http(s)://${bucket}.oss-${region}.aliyuncs.com/${object}'."\n" + ."\n" + .' 示例: https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav'."\n" + ."\n" + .'> OSS bucket 必须与服务在同一区域,否则会导致访问失败', + 'type' => 'string', + 'required' => false, + 'example' => 'url', + ], + 'Data' => [ + 'description' => '具体访问链接', + 'type' => 'string', + 'required' => false, + 'example' => 'https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav', + ], + 'Format' => [ + 'description' => '音频文件类型，只支持wav。', + 'type' => 'string', + 'required' => false, + 'example' => 'wav', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '550e8400********55440000', + ], + 'VoiceprintId' => [ + 'description' => '用户注册的声纹id', + 'type' => 'string', + 'example' => 'vp_1699123456_8527', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"550e8400********55440000\\",\\n \\"VoiceprintId\\": \\"vp_1699123456_8527\\"\\n}","type":"json"}]', + 'title' => '注册人声声纹', + ], + 'ClearAIAgentVoiceprint' => [ + 'summary' => '清除声纹ID对应的声纹', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'VoiceprintId', + 'in' => 'query', + 'schema' => [ + 'description' => '用于唯一标识一个声纹的身份标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'vp_1699123456_8527', + ], + ], + [ + 'name' => 'RegistrationMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '清除声纹', + ], + 'ListAIAgentVoiceprints' => [ + 'summary' => '更新回调配置', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'VoiceprintId', + 'in' => 'query', + 'schema' => [ + 'description' => '声纹识别的唯一身份ID。选填。不填写则罗列账号下的声纹id，填写则展示填写的声纹id。', + 'type' => 'string', + 'required' => false, + 'example' => 'vp_1699123456_8527'."\n", + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页数目。不小于1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。取值范围: [1,100]', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'RegistrationMode', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Voiceprints' => [ + 'description' => '声纹信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '声纹信息', + 'type' => 'object', + 'properties' => [ + 'VoiceprintId' => [ + 'description' => '声纹识别的唯一身份ID。', + 'type' => 'string', + 'example' => 'vp_1699123456_8527', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-28T10:03:58.000+00:00', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2025-07-28T10:03:58.000+00:00', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '声纹总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Voiceprints\\": [\\n {\\n \\"VoiceprintId\\": \\"vp_1699123456_8527\\",\\n \\"GmtCreate\\": \\"2025-07-28T10:03:58.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-28T10:03:58.000+00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + 'title' => '列出人声声纹', + ], + 'SubmitAIAgentVideoAuditTask' => [ + 'summary' => '该接口是一个视频送审服务,通过AI智能体对视频内容进行审核,支持OSS输入,允许用户自定义视频截帧策略和审核规则,并通过异步回调的方式返回审核结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236524', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体Id。', + 'type' => 'string', + 'required' => true, + 'example' => '*******3b3d94abda22******', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + ."\n" + .'- OSS：OSS文件地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址。'."\n" + .'形如'."\n" + ."\n" + .'http(s)://{BucketName}.{Endpoint}/{ObjectName}'."\n" + ."\n" + .'当前只支持和服务同地域的OSS，比如上海区域的接口服务只支持上海的OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://my-bucket.oss-cn-shanghai.aliyuncs.com/object-id.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义消息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Custom":"你好"}', + ], + ], + [ + 'name' => 'CallbackConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '回调配置', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '用户希望接收回调通知的URL', + 'type' => 'string', + 'required' => false, + 'example' => 'https://yourcallback', + ], + 'Token' => [ + 'description' => '回调的鉴权token，', + 'type' => 'string', + 'required' => false, + 'example' => 'Bearer Token', + ], + ], + 'required' => false, + 'example' => '{"Url":"https://yourcallback","Token":"yourtoken"}', + ], + ], + [ + 'name' => 'AuditInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '送审节奏（毫秒）：范围为0-5000ms，默认值为3000ms。 当入参为0时，则将CapturePolicies中的所有截帧后的数据一次性请求对应Agent中的大模型。 如果值为非0，例如3000ms，则代表着将所有截帧后的数据按3000ms为间隔有序请求大模型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'CapturePolicies', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '送审策略数组。每个策略会得到一个模型结果。', + 'type' => 'array', + 'items' => [ + 'description' => '单个策略。', + 'type' => 'object', + 'properties' => [ + 'FrameCount' => [ + 'description' => '需要截取的帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'StartTime' => [ + 'description' => '触发截帧的时刻（秒）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Duration' => [ + 'description' => '单次截帧时长（秒）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'Prompt' => [ + 'description' => '请求多模态大模型时的文本参数。', + 'type' => 'string', + 'required' => false, + 'example' => '请分析视频中的场景', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务Id', + 'type' => 'string', + 'example' => '**********fb04483915d4f2**********', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '**********-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"**********fb04483915d4f2**********\\",\\n \\"RequestId\\": \\"**********-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '提交视频送审任务', + 'description' => '通过SubmitAIAgentVideoAuditTask接口，用户可以提交包含视频地址、截帧策略、审核间隔等配置的审核任务，系统会返回一个唯一的JobId用于任务追踪,当任务完成后，系统会将审核结果（包括审核状态、AI评估内容等）推送到用户配置的回调地址。仅支持 OSS 视频链接，mllm只支持非流式openai协议，非流式OpenAI协议返回可以参考：[自研模型标准API说明](~~2839094~~)', + 'responseParamsDescription' => '### 回调消息格式 '."\n" + ."\n" + .'#### 参数说明 '."\n" + ."\n" + .'| 参数 | 类型 | 描述 | 示例值 |'."\n" + .'|------------|------------|----------------------|------------------------------------------------------------------------|'."\n" + .'| JobId | String | 任务ID | *******bb940f584ccbef******** |'."\n" + .'| Status | String | 任务状态 | Success/Fail |'."\n" + .'| Results | Array | 处理结果数组 | - |'."\n" + .'| > | JSON Object | 审核结果结构体 | - |'."\n" + .'| >> Content | String | MLLM返回的结果 | 这几张图片审核通过！ |'."\n" + .'| UserData | String | 用户自定义数据 | {"businessId": "xxx"} |'."\n" + .'| Message | String | 消息 | "Success" |'."\n" + ."\n" + .'#### 响应示例 '."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "JobId": "*******bb940f584ccbef********",'."\n" + .' "Status": "Success",'."\n" + .' "Results": ['."\n" + .' {'."\n" + .' "Content": "这几张图片审核通过！"'."\n" + .' }'."\n" + .' ],'."\n" + .' "UserData": "{\\"businessId\\": \\"xxx\\"}",'."\n" + .' "Message": "Success"'."\n" + .'}', + ], + 'GetAiRtcLicenseInfoList' => [ + 'summary' => '查询指定条件下的AI实时互动授权批次详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'LicenseItemId', + 'in' => 'query', + 'schema' => [ + 'description' => '批次ID。', + 'type' => 'string', + 'required' => false, + 'example' => '17712***', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态：'."\n" + .'- `1` - 正常'."\n" + .'- `2` - 过期', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类型：'."\n" + .'- `1` - 语音通话'."\n" + .'- `2` - 视觉理解'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NeedTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要总数，默认`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'httpStatusCode', + ], + 'LicenseInfoList' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '响应数据。', + '$ref' => '#/components/schemas/AiRtcLicenseInfoDTO', + ], + ], + 'TotalCount' => [ + 'description' => '总数'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 0,\\n \\"LicenseInfoList\\": [\\n {\\n \\"CreationTime\\": \\"\\",\\n \\"ModificationTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"LicenseItemId\\": \\"\\",\\n \\"Status\\": 0,\\n \\"ValidDays\\": 0,\\n \\"ExpiredOn\\": \\"\\",\\n \\"BeginOn\\": \\"\\",\\n \\"LicenseCount\\": 0,\\n \\"AvailableCapacity\\": 0,\\n \\"InstanceId\\": \\"\\",\\n \\"ContractNo\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '获取AI实时互动授权批次信息', + 'description' => '## 请求说明'."\n" + .'- 通过此接口，用户可以根据不同的筛选条件（如批次ID、状态、类型等）来获取AI实时互动服务的授权批次列表。'."\n" + .'- `NeedTotalCount` 参数默认为 `true`，表示响应中会包含符合条件的数据总数。如果不需要总数，可以将该参数设置为 `false`。'."\n" + .'- 当不提供任何筛选条件时，默认返回所有授权批次的信息。'."\n", + ], + 'GetAiRtcAuthCodeList' => [ + 'summary' => '查询指定批次下的AI实时互动授权码列表及状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'LicenseItemId', + 'in' => 'query', + 'schema' => [ + 'description' => '批次ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '17712***', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态：'."\n" + .'- `1` - 已激活'."\n" + .'- `2` - 未激活', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类型：'."\n" + .'- `1` - 语音通话'."\n" + .'- `2` - 视觉理解'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NeedTotalCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要总数，默认`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1***', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AuthCodeList' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '响应数据。', + '$ref' => '#/components/schemas/AiRtcAuthCodeDTO', + ], + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AuthCodeList\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": 0,\\n \\"AuthCode\\": \\"\\",\\n \\"ActivatedTime\\": \\"\\",\\n \\"DeviceId\\": \\"\\",\\n \\"CreationTime\\": \\"\\",\\n \\"License\\": \\"\\",\\n \\"ModificationTime\\": \\"\\",\\n \\"LicenseItemId\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","type":"json"}]', + 'title' => '获取AI实时互动授权码信息', + 'description' => '## 请求说明'."\n" + .'- 通过此接口可以获取特定批次ID下的授权码列表，并可按状态、类型进行筛选。'."\n" + .'- 支持分页查询，用户可以通过设置`PageNo`和`PageSize`来控制返回的数据量。'."\n" + .'- 如果需要获取总记录数，请确保`NeedTotalCount`参数设为`true`（默认值）。'."\n" + .'- `LicenseItemId`是必填项，用于指定查询的具体批次。'."\n", + ], + 'ActiveAiRtcLicense' => [ + 'summary' => '根据批次ID、授权码和设备SN信息激活指定的License。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceMX4DML', + ], + ], + 'parameters' => [ + [ + 'name' => 'LicenseItemId', + 'in' => 'query', + 'schema' => [ + 'description' => '批次ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '17712***', + ], + ], + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'description' => '授权码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'iU1IeJech7***', + ], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'device-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4F9C14FE-1147-15AC-8EDF-A590FF12***', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'License' => [ + 'description' => 'license信息。', + 'type' => 'string', + 'example' => 'a659a06659a***', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F9C14FE-1147-15AC-8EDF-A590FF12***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"License\\": \\"a659a06659a***\\"\\n}","type":"json"}]', + 'title' => '激活AI实时互动License', + 'description' => '## 请求说明'."\n" + .'本接口用于通过提供批次ID（`LicenseItemId`）、授权码（`AuthCode`）以及设备ID（`DeviceId`）来激活特定的AI实时互动服务License。激活成功后，将返回包含请求ID、错误码、请求状态、HTTP状态码及激活后的License信息。'."\n" + ."\n" + .'**注意**：请确保提供的批次ID、授权码与设备ID准确无误，否则可能导致激活失败。'."\n", + ], + 'SubmitVideoCognitionJob' => [ + 'summary' => '提交视频理解任务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '视频标题，支持中英文、数字、中划线（-），不能以特殊符号开头，长度不能超过 256B。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'example-title-**** ', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '额外的请求参数，使用 JSON 字符串表示。支持自然语言处理，分镜，自定义标签，动作识别等算子的额外参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "nlpParams": {'."\n" + .' "sourceLanguage": "cn",'."\n" + .' "diarizationEnabled": true,'."\n" + .' "speakerCount": 2,'."\n" + .' "summarizationEnabled": true,'."\n" + .' "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap",'."\n" + .' "translationEnabled": true,'."\n" + .' "targetLanguages": "en",'."\n" + .' "autoChaptersEnabled": true,'."\n" + .' "meetingAssistanceEnabled": true'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，获取结果时原样返回。长度不超过 1024 字节。', + 'type' => 'string', + 'required' => false, + 'example' => '{"test":1}', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'input', + 'description' => '输入媒体结构', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体类型，支持以下三种类型：'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- Media'."\n" + ."\n" + .'- URL', + 'type' => 'string', + 'required' => false, + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '上述 Type 参数设置为 OSS 时，写 OSS 地址，例如：OSS://test-bucket/video/202208/test.mp4'."\n" + ."\n" + .'Type 为 Media 时写 mediaId：c5c62d8f0361337cab312dce8e77dc6d'."\n" + ."\n" + .'Type 为 URL 时写 http url，例如：https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4', + 'type' => 'string', + 'required' => false, + 'example' => 'c5c62d8f03613************c6d', + ], + ], + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板 ID 用于指定分析算法，模板相关操作参见[创建用户自定义模板](https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-createcustomtemplate?spm=a2c4g.11186623.help-menu-193643.d_5_0_3_3_0_0.17b66afamjKySv)和[智能标签模版](https://help.aliyun.com/zh/ims/user-guide/smart-tagging-template?spm=a2c4g.11186623.0.i15)', + 'type' => 'string', + 'required' => false, + 'example' => '39f8e0bc00***************', + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '任务Id。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交视频智能内容理解任务', + 'requestParamsDescription' => '### nlpParams说明'."\n" + ."\n" + .'| 功能 | 名称 | 类型 | 必填 | 描述 | 示例值 |'."\n" + .'|------|------|------|------|------|--------|'."\n" + .'| | nlpParams | object | 是 | 该参数包含了所有nlp处理的相关参数，template分析类型包含nlp的时候必填，否则任务失败。 | {"sourceLanguage":"cn"} |'."\n" + .'| 转录 | sourceLanguage | string | 是 | 转写使用的源语言模型，可选：cn（中文）、en（英文）、yue（粤语）、fspk（中英文自由说）。 | "cn" |'."\n" + .'| | diarizationEnabled | boolean | 否 | 是否开启说话人分离功能，默认false。 | true |'."\n" + .'| | speakerCount | integer | 否 | 设置说话人分离参数。不设置：不使用说话人角色区分。0：说话人角色区分结果为不定人数。2：说话人角色区分结果为2人。 | 2 |'."\n" + .'| 摘要 | summarizationEnabled | boolean | 否 | 是否启用摘要功能，开启后会可以生成全文摘要、发言人总结等结果。 | true |'."\n" + .'| | summarizationTypes | string | 否 | 开启摘要功能时，需传入期望的摘要类型：Paragraph（全文摘要）、Conversational（发言人总结）、QuestionsAnswering（问答摘要）、MindMap（思维导图）。 | "Paragraph,Conversational,QuestionsAnswering,MindMap" |'."\n" + .'| 翻译 | translationEnabled | boolean | 否 | 是否启用翻译功能。 | true |'."\n" + .'| | targetLanguages | string | 否 | 开启翻译功能后的目标语言，可选：cn（中文）、en（英文）、yue（粤语）、fspk（中英文自由说）。 | "en,cn" |'."\n" + .'| 章节识别 | autoChaptersEnabled | boolean | 否 | 是否启用章节速览功能，结果包含章节标题、章节摘要。 | true |'."\n" + .'| 智能纪要 | meetingAssistanceEnabled | boolean | 否 | 是否开启会议协助功能，结果包含分类、关键词、关键句、待办事项。 | true |', + ], + 'QueryVideoCognitionJob' => [ + 'summary' => '查询视频理解任务结果', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的智能标签作业ID。可以从[提交智能标签作业](~~478786~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '额外的请求参数，使用 JSON 字符串表示', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'IncludeResults', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询结果中是否包含完整算法结果。', + 'type' => 'object', + 'properties' => [ + 'NeedAsr' => [ + 'description' => '是否显示asr结果', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'NeedOcr' => [ + 'description' => '是否显示ocr结果', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'NeedProcess' => [ + 'description' => '是否显示算子原始结果链接', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobStatus' => [ + 'description' => '任务状态，可取值：'."\n" + ."\n" + .'- **Success**：处理成功。'."\n" + ."\n" + .'- **Fail**：处理失败。'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + ."\n" + .'- **Submitted**：已提交等待处理。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******'."\n", + ], + 'UserData' => [ + 'description' => '用户自定义信息。', + 'type' => 'string', + 'example' => '{"userId":"123432412831"}'."\n", + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'result' => [ + 'description' => '分析结果对象数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分析结果的类型。'."\n" + ."\n" + .'1. TextLabel：文本标签'."\n" + .'2. VideoLabel：视频标签'."\n" + .'3. ASR：语音识别原始结果（默认不返回）'."\n" + .'4. OCR：文字识别原始结果（默认不返回）'."\n" + .'5. NLP：NLP处理结果（默认不返回）'."\n" + .'6. Process：算子原始结果链接（默认不返回）', + 'type' => 'string', + 'example' => 'ASR', + ], + 'Data' => [ + 'description' => '分析结果的具体数据，以JSON字符串表示。不同Type的数据结构见下文Result参数说明。', + 'type' => 'string', + 'example' => '{"title":"example-title-****"} '."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\\\n\\",\\n \\"UserData\\": \\"{\\\\\\"userId\\\\\\":\\\\\\"123432412831\\\\\\"}\\\\n\\",\\n \\"Results\\": {\\n \\"result\\": [\\n {\\n \\"Type\\": \\"ASR\\",\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\\\t\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询智能内容理解任务', + 'responseParamsDescription' => '**Result参数说明**'."\n" + ."\n" + .'**VideoLabel**数据结构'."\n" + .'| 名称 | 类型 |描述|'."\n" + .'|---------------|--------|-----------|'."\n" + .'| persons|JSONArray | 检测到的人物结果|'."\n" + .'|persons.name |String | 识别到的人物名称|'."\n" + .'| persons.category| String|人物类型，取值如下：`celebrity`（名人）；`politician`（政治人物）；`sensitive`（敏感人物）；`unknown`（未知人物）；自定义人物库ID（识别到的人物为自定义人物时返回） |'."\n" + .'|persons.ratio | double| 人物出现率，取值：0~1|'."\n" + .'| persons.occurrences| JSONArray| 人物出场详细信息|'."\n" + .'|persons.occurrences.score | double| 置信度得分|'."\n" + .'|persons.occurrences.from | double|检测到人物的起始时间，单位（秒） |'."\n" + .'|persons.occurrences.to |double |检测到人物的结束时间，单位（秒） |'."\n" + .'| persons.occurrences.position|JSONObject |人脸坐标 |'."\n" + .'|persons.occurrences.position.leftTop |int[] |左上角x，y坐标 |'."\n" + .'| persons.occurrences.position.rightBottom|int[] |右下角x，y坐标 |'."\n" + .'| persons.occurrences.timestamp| double|人脸坐标所在的时间戳，单位为秒 |'."\n" + .'|persons.occurrences.scene |String |人物镜头，包括：`closeUp`（特写）；`medium-closeUp`（近景）；`medium`（中景）；`medium-long`（全景） |'."\n" + .'|tags | JSONArray| 检测到的物体场景等标签，详见下表举例|'."\n" + .'|tags.mainTagName |String |主标签 |'."\n" + .'| tags.subTagName| String| 子标签|'."\n" + .'|tags.ratio |double |出现率，取值：0~1 |'."\n" + .'|tags.occurrences | JSONArray|出现详细信息 |'."\n" + .'|tags.occurrences.score |double |置信度得分 |'."\n" + .'|tags.occurrences.from | double|起始时间，单位（秒） |'."\n" + .'|tags.occurrences.to |double | 结束时间，单位（秒）|'."\n" + .'| classifications| JSONArray| 视频分类信息|'."\n" + .'|classifications.score |double |置信度得分 |'."\n" + .'| classifications.category1| String|一级分类，比如：生活、动漫、汽车等等 |'."\n" + .'|classifications.category2 |String | 二级分类，比如生活下面细分为：健康、家居等等|'."\n" + ."\n" + .'视频Tags标签举例说明'."\n" + .'| mainTagName|subTagName |'."\n" + .'|---------------|--------|'."\n" + .'|节目 | 比如：爸爸去哪儿、欢乐喜剧人等|'."\n" + .'|人物角色 | 比如：医生、护士、教师等|'."\n" + .'| 物体|比如：钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n" + .'| 标识| 比如：CCTV1、CCTV2、优酷、东方卫视等|'."\n" + .'| 动作事件| 比如：跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n" + .'|地域 |比如：北京天安门、自由女神像、乐山大佛、中国、美国等 |'."\n" + .'| 场景| 比如：卧室、地铁站、梯田、海滩、沙漠等|'."\n" + ."\n" + .'**ImageLabel**数据结构'."\n" + .'|名称 |类型 |描述|'."\n" + .'|----------|--------|----|'."\n" + .'|persons | JSONArray| 检测到的人物结果|'."\n" + .'|persons.name | String|识别到的人物名称 |'."\n" + .'|persons.category | String|人物类型，取值如下：celebrity（名人）；politician（政治人物）；sensitive（敏感人物） |'."\n" + .'|persons.score | double|人物置信度得分 |'."\n" + .'| persons.position| JSONObject| 人脸坐标|'."\n" + .'| persons.position.leftTop| int[]| 左上角x，y坐标|'."\n" + .'| persons.position.rightBottom|int[] |右下角x，y坐标 |'."\n" + .'|persons.scene | String|人物镜头，包括：closeUp（特写）；medium-closeUp（近景）；medium（中景）；medium-long（全景） |'."\n" + .'| tags|JSONArray |检测到的物体场景等标签，详见下表举例 |'."\n" + .'| tags.mainTagName|String |主标签 |'."\n" + .'|tags.subTagName | String|子标签 |'."\n" + .'|tags.score |double |置信度得分 |'."\n" + ."\n" + .'图片tags标签举例说明'."\n" + .'| mainTagName|subTagName |'."\n" + .'|---------------|--------|'."\n" + .'|人物角色| 比如：医生、护士、教师等|'."\n" + .'|地域 | 比如：北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n" + .'| 动作事件|比如：讲话等 |'."\n" + .'| 标识| 比如：CCTV1、CCTV2、优酷、东方卫视等|'."\n" + .'| 动作事件| 比如：跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n" + .'|物体 |比如：钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n" + .'| 场景| 比如：卧室、地铁站、梯田、海滩、沙漠等|'."\n" + ."\n" + .'TextLabel数据结构（来源于ASR和OCR）'."\n" + .'|名称 |类型 |描述|'."\n" + .'|----------|--------|----|'."\n" + .'|tags |JSONArray |文本标签信息，详见下表举例 |'."\n" + .'| tags.name| String|标签类别 |'."\n" + .'|tags.value |String |标签值，可能有多个标签值，以半角逗号（,）分割 |'."\n" + ."\n" + .'图片tags标签举例说明'."\n" + .'| name|value |'."\n" + .'|---------------|--------|'."\n" + .'|地域| 比如：北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n" + .'|组织机构 |比如：中国生动物保护协会、中央广播电视台等 |'."\n" + .'|标识 | 比如：耐克、李宁|'."\n" + .'|关键词 |比如：中坚力量 |'."\n" + ."\n" + .'**CPVLabel**数据结构'."\n" + .'- cates：类目（一级类目、二级类目、三级类目）'."\n" + .'- entities：类目属性（带有知识图谱信息）'."\n" + .'- hotwords：热点词（用户关注的名单）'."\n" + .'- freeTags：自由标签（关键词）'."\n" + ."\n" + .'| 名称 | 类型 |示例值|说明|'."\n" + .'|---------------|--------|-----------|------|'."\n" + .'|type|String|hmi|结果类型。取值：hmi（人机协同结果）、autp（机器打标结果）|'."\n" + .'|cates|JSONArray|-|分类类目结果|'."\n" + .'|cates.labelLevel1|String|旅游|一级标签|'."\n" + .'| cates.labelLevel2 |String | 旅游风光 |二级标签 |'."\n" + .'| cates.label | String | "" |标签名称，算法可能返回空 |'."\n" + .'| cates.appearanceProbability | double | 0.96 | 出现率 |'."\n" + .'|cates.detailInfo |JSONArray |- | -|'."\n" + .'| cates.detailInfo.score | double|0.9 | 置信度 |'."\n" + .'|cates.detailInfo.startTime |double | 0.021 | 开始时间 |'."\n" + .'|cates.detailInfo.endTime |double |29.021 |结束时间 |'."\n" + .'| entities| JSONArray|- | -|'."\n" + .'|entities.labelLevel1 |String | 地域|一级标签 |'."\n" + .'| entities.labelLevel2| String| 地标|二级标签 |'."\n" + .'| entities.label|String | 黄果树瀑布| 标签名称|'."\n" + .'|entities.appearanceProbability | double|0.067 |出现率 |'."\n" + .'|entities.knowledgeInfo |String |{"name": "黄果树瀑布", "nameEn": "Huangguoshu Waterfall", "description": "亚洲四大瀑布之一"} |知识图谱信息，全部字段后附表：影视综IP图谱、音乐图谱、人物图谱、地标图谱、物体图谱。 |'."\n" + .'| entities.detailInfo|JSONArray |- |- |'."\n" + .'| entities.detailInfo.score| double|0.33292606472969055 | 置信度|'."\n" + .'|entities.detailInfo.startTime |double |6.021 | 开始时间|'."\n" + .'|entities.detailInfo.endTime |double |8.021 | 结束时间|'."\n" + .'|entities.detailInfo.trackData |JSONArray |- |实体标签结构化信息 |'."\n" + .'| entities.detailInfo.trackData.score| double|0.32 | 置信度|'."\n" + .'|entities.detailInfo.trackData.bbox |integer[] | 23，43，45，67| 坐标框|'."\n" + .'|entities.detailInfo.trackData.timestamp | double| 7.9|时间戳 |'."\n" + .'|hotwords |JSONArray | -|- |'."\n" + .'|hotwords.labelLevel1 | String|关键词 | 一级标签|'."\n" + .'|hotwords.labelLevel1 | String|关键词 |二级标签 |'."\n" + .'|hotwords.labelLevel2 |String |"" |二级标签 |'."\n" + .'|hotwords.label |String |中国气象局 |看点词内容 |'."\n" + .'| hotwords.appearanceProbability|double | 0.96|出现率 |'."\n" + .'|hotwords.detailInfo | JSONArray| | |'."\n" + .'| hotwords.detailInfo.score|double | 1.0| 置信度|'."\n" + .'|hotwords.detailInfo.startTime | double|0.021 |开始时间 |'."\n" + .'|hotwords.detailInfo.endTime | double| 29.021|结束时间 |'."\n" + .'| freeTags|JSONArray | | |'."\n" + .'|freeTags.labelLevel1 |String |关键词 |一级标签 |'."\n" + .'|freeTags.labelLevel2 | String| ""| 二级标签|'."\n" + .'|freeTags.label |String |中央气象台 |看点词内容 |'."\n" + .'|freeTags.appearanceProbability |double |0.96 | 出现率|'."\n" + .'|freeTags.detailInfo | JSONArray| | |'."\n" + .'|freeTags.detailInfo.score |double |0.9 | 置信度|'."\n" + .'| freeTags.detailInfo.startTime|double | 0.021| 开始时间|'."\n" + .'|freeTags.detailInfo.endTime |double | 29.021|结束时间 |'."\n" + ."\n" + .'**语音识别ASR结果**'."\n" + .'|名称 | 类型| 描述|'."\n" + .'|---------------|--------|-----------|'."\n" + .'| details|JSONArray | 任务详细结果|'."\n" + .'| details.from| double|开始时间戳，单位（秒） |'."\n" + .'|details.to |double |结束时间戳，单位（秒） |'."\n" + .'| details.content|String |识别出的文本内容 |'."\n" + ."\n" + .'**文本识别OCR结果**'."\n" + .'|名称 |类型 |描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|details |JSONArray |任务详细结果 |'."\n" + .'|details.timestamp |double | 时间戳信息，单位（秒）|'."\n" + .'|details.info | JSONArray|该时间点识别出的具体信息 |'."\n" + .'|details.info.score |double |置信度得分 |'."\n" + .'|details.info.position |JSONObject |文字坐标 |'."\n" + .'|details.info.position.leftTop |int[] | 左上角x，y坐标|'."\n" + .'|details.info.position.rightBottom |int[] |右下角x，y坐标 |'."\n" + .'| details.info.content| String|识别出的文本内容 |'."\n" + ."\n" + .'**Meta标注结果**'."\n" + .'> 如果客户没有使用人机标注，在使用[SubmitSmarttagJob](~~478786~~)提交任务时如果指定了needMetaData，目前QuerySmarttagJob返回结果时会返回原始客户输入的标题。'."\n" + ."\n" + .'|名称 | 类型|描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|title | String| 标题|'."\n" + ."\n" + .'**字幕提取结果Subtitle**'."\n" + .'|名称 |类型 |描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|details |JSONArray |任务详细结果 |'."\n" + .'|details.allResultUrl|String|全部字幕结果URL，URL有效期为任务完成后半年内可有效访问 |'."\n" + .'|details.chResultUrl|String|中文结果URL，URL有效期为任务完成后半年内可有效访问 |'."\n" + .'|details.engResultUrl|String|英文结果URL，URL有效期为任务完成后半年内可有效访问|'."\n" + .'> 字幕结果URL内容：`序号+时间段+字幕内容（每句字幕为一行）`。'."\n" + ."\n" + .'**NLP处理结果**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| transcription | object | 语音转写结果 |'."\n" + .'| autoChapters | object | 章节速览结果 |'."\n" + .'| summarization | object | 大模型摘要结果 |'."\n" + .'| meetingAssistance | object | 智能纪要结果 |'."\n" + .'| translation | object | 文本翻译结果 |'."\n" + ."\n" + .'**transcription（语音转录）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| transcription | object | 语音转写结果对象。 |'."\n" + .'| transcription.paragraphs | list[] | 语音转写结构以段落形式组织的集合。 |'."\n" + .'| transcription.paragraphs[i].paragraphId | string | 段落级别id。 |'."\n" + .'| transcription.paragraphs[i].speakerId | string | 发言人id。 |'."\n" + .'| transcription.paragraphs[i].words | list[] | 该段落包含的word信息。 |'."\n" + .'| transcription.paragraphs[i].words[i].id | int | word序号，通常无须关注。 |'."\n" + .'| transcription.paragraphs[i].words[i].sentenceId | int | 句子id，同属于一个SentenceId的word信息可以组装成一句话。 |'."\n" + .'| transcription.paragraphs[i].words[i].start | long | 该word相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| transcription.paragraphs[i].words[i].end | long | 该word相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| transcription.paragraphs[i].words[i].text | string | word文本。 |'."\n" + ."\n" + .'**summarization（全文摘要、发言人总结、提问摘要）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| summarization | object | 摘要结果对象，可能包含0个或多个不同摘要类型的结果。 |'."\n" + .'| summarization.paragraphSummary | string | 全文摘要结果。 |'."\n" + .'| summarization.conversationalSummary | list[] | 发言总结摘要结果列表。 |'."\n" + .'| summarization.conversationalSummary[i].speakerId | string | 发言人id。 |'."\n" + .'| summarization.conversationalSummary[i].speakerName | string | 发言人名字。 |'."\n" + .'| summarization.conversationalSummary[i].summary | string | 该发言人对应的总结。 |'."\n" + .'| summarization.questionsAnsweringSummary | list[] | 问答摘要结果列表。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].question | string | 问题 |'."\n" + .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfQuestion | list[] | 提炼出该问题对应的原语音转写的SentenceId列表。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].answer | string | 问题对应的答案。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfAnswer | list[] | 总结出该答案对应的原语音转写的SentenceId列表。 |'."\n" + .'| summarization.mindMapSummary | list[object] | 思维导图摘要结果列表，可能包含各个主题的摘要、主题间的关系等。 |'."\n" + .'| summarization.mindMapSummary[i].title | string | 主题的标题。 |'."\n" + .'| summarization.mindMapSummary[i].topic | list[object] | 包含每个主题及其子主题的数组 |'."\n" + .'| summarization.mindMapSummary[i].topic[i].title | string | 主题的标题。 |'."\n" + .'| summarization.mindMapSummary[i].topic[i].topic | list[object] | 主题的子主题数组，可以是空数组。 |'."\n" + ."\n\n" + ."\n" + .' **translation（全文翻译）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| translation | object | 翻译结果对象。 |'."\n" + .'| translation.paragraphs | list[] | 翻译结果以段落形式组织的集合，和语音识别结果报文对应。 |'."\n" + .'| translation.paragraphs.paragraphId | string | 段落分段id标识，和语音识别结果中的ParagraphId对应。 |'."\n" + .'| translation.paragraphs.sentences | list[] | 翻译文本集合。 |'."\n" + .'| translation.paragraphs.sentences[i].sentenctId | long | 句子id。 |'."\n" + .'| translation.paragraphs.sentences[i].start | long | 该段相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| translation.paragraphs.sentences[i].end | long | 该段相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| translation.paragraphs.sentences[i].text | string | 翻译文本，和语音识别结果报文对应。 |'."\n" + ."\n" + .'**autoChapters（章节识别）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| autoChapters | list[] | 章节速览集合， 含有0个、1个或多个章节速览信息。 |'."\n" + .'| autoChapters[i].id | int | 该章节序号。 |'."\n" + .'| autoChapters[i].start | long | 该章节相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| autoChapters[i].end | long | 该章节相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| autoChapters[i].headline | string | 该章节的一句话标题。 |'."\n" + .'| autoChapters[i].summary | string | 章节总结。 |'."\n" + ."\n" + .'**meetingAssistance（智能纪要提取，包含关键词、关键句、待办事项提取）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| meetingAssistance | object | 智能纪要结果对象，可能包含0个或多个不同类型的结果。 |'."\n" + .'| meetingAssistance.keywords | list[] | 关键词提取结果。 |'."\n" + .'| meetingAssistance.keySentences | list[] | 关键句提取结果，也称为重点内容。 |'."\n" + .'| meetingAssistance.keySentences[i].id | long | 关键句序号。 |'."\n" + .'| meetingAssistance.keySentences[i].sentenceId | long | 该关键句在原ASR转写中对应的句子Id。 |'."\n" + .'| meetingAssistance.keySentences[i].start | long | 相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.keySentences[i].end | long | 相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.keySentences[i].text | string | 关键句信息。 |'."\n" + .'| meetingAssistance.actions | list[] | 待办内容、待办摘要的集合。 |'."\n" + .'| meetingAssistance.actions[i].id | long | 待办序号。 |'."\n" + .'| meetingAssistance.actions[i].sentenceId | long | 该关键句在原ASR转写中对应的句子Id。 |'."\n" + .'| meetingAssistance.actions[i].start | long | 相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.actions[i].end | long | 相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.actions[i].text | string | 待办内容。 |'."\n" + .'| meetingAssistance.classifications | object | 场景分类，目前只有3中场景分类。 |'."\n" + .'| meetingAssistance.classifications.interview | float | 面试场景置信度得分。 |'."\n" + .'| meetingAssistance.classifications.lecture | float | 演讲场景置信度得分。 |'."\n" + .'| meetingAssistance.classifications.meeting | float | 会议场景置信度得分。 |', + ], + 'QuerySmarttagJob' => [ + 'summary' => '查询智能标签任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的智能标签作业ID。可以从[提交智能标签作业](~~478786~~)的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '88c6ca184c0e47098a5b665e2****', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '额外的请求参数，使用JSON字符串表示，例如：{"labelResultType":"auto"}。其中，labelResultType为String类型，可取值：'."\n" + ."\n" + .'- auto：机器打标结果'."\n" + ."\n" + .'- hmi：人机协同结果', + 'type' => 'string', + 'required' => false, + 'example' => '{"labelResultType":"auto"} '."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobStatus' => [ + 'description' => '任务状态，可取值：'."\n" + ."\n" + .'- **Success**：处理成功。'."\n" + ."\n" + .'- **Fail**：处理失败。'."\n" + ."\n" + .'- **Processing**：处理中。'."\n" + ."\n" + .'- **Submitted**：已提交等待处理。'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'UserData' => [ + 'description' => '通过MNS回调时透传回来的信息。消息格式请参见下文回调消息格式定义。'."\n" + ."\n", + 'type' => 'string', + 'example' => '{"userId":"123432412831"}', + ], + 'Results' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => '分析结果对象数组。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '分析结果的类型。'."\n" + ."\n" + .'- [ ] - 标签1.0分析结果类型：'."\n" + ."\n\n" + .'1. TextLabel：文本标签'."\n" + .'2. VideoLabel：视频标签'."\n" + .'3. ASR：语音识别原始结果（默认不返回）'."\n" + .'4. OCR：文字识别原始结果（默认不返回）'."\n" + .'5. NLP：NLP处理结果（默认不返回）'."\n" + ."\n\n" + .'- [ ] - 标签2.0分析结果类型：'."\n" + ."\n" + .'1. CPVLabel'."\n" + .'2. Meta：视频标题等信息（默认不返回）'."\n" + ."\n" + .'- [ ] - 标签2.0-custom分析结果类型：'."\n" + ."\n" + .'1. CPVLabel'."\n" + .'2. Meta：视频标题等信息（默认不返回）', + 'type' => 'string', + 'example' => 'Meta', + ], + 'Data' => [ + 'description' => '分析结果的具体数据，以JSON字符串表示。不同Type的数据结构见下文Result参数说明。'."\n" + ."\n", + 'type' => 'string', + 'example' => '{"title":"example-title-****"} '."\n", + ], + ], + ], + ], + ], + ], + 'Usages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Usage' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'Quota' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobStatus\\": \\"Success\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"UserData\\": \\"{\\\\\\"userId\\\\\\":\\\\\\"123432412831\\\\\\"}\\",\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Type\\": \\"Meta\\",\\n \\"Data\\": \\"{\\\\\\"title\\\\\\":\\\\\\"example-title-****\\\\\\"}\\\\t\\\\n\\"\\n }\\n ]\\n },\\n \\"Usages\\": {\\n \\"Usage\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Quota\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '智能标签任务查询接口', + 'responseParamsDescription' => '**回调消息格式定义**'."\n" + .'当智能标签任务执行状态改变时，mps会发送消息到用户指定的queue中（如何指定回调queue详见mps的更新管道接口）。消息体是一个JSON字符串，包含字段如下：'."\n" + .'| 名称 | 类型 |描述|'."\n" + .'|---------------|--------|-----------|'."\n" + .'|Type |String |固定字符串“smarttag”，表示智能标签任务 |'."\n" + .'|JobId | String|任务唯一ID |'."\n" + .'|State | String| 任务当前状态，与QuerySmarttagJob中的JobStatus一致|'."\n" + .'|State | String|任务当前状态，与QuerySmarttagJob中的JobStatus一致|'."\n" + .'|UserData |String | 用户在SubmitSmarttagJob中传入的UserData|'."\n" + .'|UserData |String |用户在SubmitSmarttagJob中传入的UserData|'."\n" + ."\n" + .'**Result参数说明**'."\n" + ."\n" + .'**VideoLabel**数据结构'."\n" + .'| 名称 | 类型 |描述|'."\n" + .'|---------------|--------|-----------|'."\n" + .'| persons|JSONArray | 检测到的人物结果|'."\n" + .'|persons.name |String | 识别到的人物名称|'."\n" + .'| persons.category| String|人物类型，取值如下：`celebrity`（名人）；`politician`（政治人物）；`sensitive`（敏感人物）；`unknown`（未知人物）；自定义人物库ID（识别到的人物为自定义人物时返回） |'."\n" + .'|persons.ratio | double| 人物出现率，取值：0~1|'."\n" + .'| persons.occurrences| JSONArray| 人物出场详细信息|'."\n" + .'|persons.occurrences.score | double| 置信度得分|'."\n" + .'|persons.occurrences.from | double|检测到人物的起始时间，单位（秒） |'."\n" + .'|persons.occurrences.to |double |检测到人物的结束时间，单位（秒） |'."\n" + .'| persons.occurrences.position|JSONObject |人脸坐标 |'."\n" + .'|persons.occurrences.position.leftTop |int[] |左上角x，y坐标 |'."\n" + .'| persons.occurrences.position.rightBottom|int[] |右下角x，y坐标 |'."\n" + .'| persons.occurrences.timestamp| double|人脸坐标所在的时间戳，单位为秒 |'."\n" + .'|persons.occurrences.scene |String |人物镜头，包括：`closeUp`（特写）；`medium-closeUp`（近景）；`medium`（中景）；`medium-long`（全景） |'."\n" + .'|tags | JSONArray| 检测到的物体场景等标签，详见下表举例|'."\n" + .'|tags.mainTagName |String |主标签 |'."\n" + .'| tags.subTagName| String| 子标签|'."\n" + .'|tags.ratio |double |出现率，取值：0~1 |'."\n" + .'|tags.occurrences | JSONArray|出现详细信息 |'."\n" + .'|tags.occurrences.score |double |置信度得分 |'."\n" + .'|tags.occurrences.from | double|起始时间，单位（秒） |'."\n" + .'|tags.occurrences.to |double | 结束时间，单位（秒）|'."\n" + .'| classifications| JSONArray| 视频分类信息|'."\n" + .'|classifications.score |double |置信度得分 |'."\n" + .'| classifications.category1| String|一级分类，比如：生活、动漫、汽车等等 |'."\n" + .'|classifications.category2 |String | 二级分类，比如生活下面细分为：健康、家居等等|'."\n" + ."\n" + .'视频Tags标签举例说明'."\n" + .'| mainTagName|subTagName |'."\n" + .'|---------------|--------|'."\n" + .'|节目 | 比如：爸爸去哪儿、欢乐喜剧人等|'."\n" + .'|人物角色 | 比如：医生、护士、教师等|'."\n" + .'| 物体|比如：钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n" + .'| 标识| 比如：CCTV1、CCTV2、优酷、东方卫视等|'."\n" + .'| 动作事件| 比如：跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n" + .'|地域 |比如：北京天安门、自由女神像、乐山大佛、中国、美国等 |'."\n" + .'| 场景| 比如：卧室、地铁站、梯田、海滩、沙漠等|'."\n" + ."\n" + .'**ImageLabel**数据结构'."\n" + .'|名称 |类型 |描述|'."\n" + .'|----------|--------|----|'."\n" + .'|persons | JSONArray| 检测到的人物结果|'."\n" + .'|persons.name | String|识别到的人物名称 |'."\n" + .'|persons.category | String|人物类型，取值如下：celebrity（名人）；politician（政治人物）；sensitive（敏感人物） |'."\n" + .'|persons.score | double|人物置信度得分 |'."\n" + .'| persons.position| JSONObject| 人脸坐标|'."\n" + .'| persons.position.leftTop| int[]| 左上角x，y坐标|'."\n" + .'| persons.position.rightBottom|int[] |右下角x，y坐标 |'."\n" + .'|persons.scene | String|人物镜头，包括：closeUp（特写）；medium-closeUp（近景）；medium（中景）；medium-long（全景） |'."\n" + .'| tags|JSONArray |检测到的物体场景等标签，详见下表举例 |'."\n" + .'| tags.mainTagName|String |主标签 |'."\n" + .'|tags.subTagName | String|子标签 |'."\n" + .'|tags.score |double |置信度得分 |'."\n" + ."\n" + .'图片tags标签举例说明'."\n" + .'| mainTagName|subTagName |'."\n" + .'|---------------|--------|'."\n" + .'|人物角色| 比如：医生、护士、教师等|'."\n" + .'|地域 | 比如：北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n" + .'| 动作事件|比如：讲话等 |'."\n" + .'| 标识| 比如：CCTV1、CCTV2、优酷、东方卫视等|'."\n" + .'| 动作事件| 比如：跳舞、接吻、拥抱、会晤、唱歌、打电话、骑马、打斗等|'."\n" + .'|物体 |比如：钢琴、水杯、桌子、西红柿炒鸡蛋、小汽车、化妆品等 |'."\n" + .'| 场景| 比如：卧室、地铁站、梯田、海滩、沙漠等|'."\n" + ."\n" + .'TextLabel数据结构（来源于ASR和OCR）'."\n" + .'|名称 |类型 |描述|'."\n" + .'|----------|--------|----|'."\n" + .'|tags |JSONArray |文本标签信息，详见下表举例 |'."\n" + .'| tags.name| String|标签类别 |'."\n" + .'|tags.value |String |标签值，可能有多个标签值，以半角逗号（,）分割 |'."\n" + ."\n" + .'图片tags标签举例说明'."\n" + .'| name|value |'."\n" + .'|---------------|--------|'."\n" + .'|地域| 比如：北京天安门、自由女神像、乐山大佛、中国、美国等|'."\n" + .'|组织机构 |比如：中国生动物保护协会、中央广播电视台等 |'."\n" + .'|标识 | 比如：耐克、李宁|'."\n" + .'|关键词 |比如：中坚力量 |'."\n" + ."\n" + .'**CPVLabel**数据结构'."\n" + .'- cates：类目（一级类目、二级类目、三级类目）'."\n" + .'- entities：类目属性（带有知识图谱信息）'."\n" + .'- hotwords：热点词（用户关注的名单）'."\n" + .'- freeTags：自由标签（关键词）'."\n" + ."\n" + .'| 名称 | 类型 |示例值|说明|'."\n" + .'|---------------|--------|-----------|------|'."\n" + .'|type|String|hmi|结果类型。取值：hmi（人机协同结果）、autp（机器打标结果）|'."\n" + .'|cates|JSONArray|-|分类类目结果|'."\n" + .'|cates.labelLevel1|String|旅游|一级标签|'."\n" + .'| cates.labelLevel2 |String | 旅游风光 |二级标签 |'."\n" + .'| cates.label | String | "" |标签名称，算法可能返回空 |'."\n" + .'| cates.appearanceProbability | double | 0.96 | 出现率 |'."\n" + .'|cates.detailInfo |JSONArray |- | -|'."\n" + .'| cates.detailInfo.score | double|0.9 | 置信度 |'."\n" + .'|cates.detailInfo.startTime |double | 0.021 | 开始时间 |'."\n" + .'|cates.detailInfo.endTime |double |29.021 |结束时间 |'."\n" + .'| entities| JSONArray|- | -|'."\n" + .'|entities.labelLevel1 |String | 地域|一级标签 |'."\n" + .'| entities.labelLevel2| String| 地标|二级标签 |'."\n" + .'| entities.label|String | 黄果树瀑布| 标签名称|'."\n" + .'|entities.appearanceProbability | double|0.067 |出现率 |'."\n" + .'|entities.knowledgeInfo |String |{"name": "黄果树瀑布", "nameEn": "Huangguoshu Waterfall", "description": "亚洲四大瀑布之一"} |知识图谱信息，全部字段后附表：影视综IP图谱、音乐图谱、人物图谱、地标图谱、物体图谱。 |'."\n" + .'| entities.detailInfo|JSONArray |- |- |'."\n" + .'| entities.detailInfo.score| double|0.33292606472969055 | 置信度|'."\n" + .'|entities.detailInfo.startTime |double |6.021 | 开始时间|'."\n" + .'|entities.detailInfo.endTime |double |8.021 | 结束时间|'."\n" + .'|entities.detailInfo.trackData |JSONArray |- |实体标签结构化信息 |'."\n" + .'| entities.detailInfo.trackData.score| double|0.32 | 置信度|'."\n" + .'|entities.detailInfo.trackData.bbox |integer[] | 23，43，45，67| 坐标框|'."\n" + .'|entities.detailInfo.trackData.timestamp | double| 7.9|时间戳 |'."\n" + .'|hotwords |JSONArray | -|- |'."\n" + .'|hotwords.labelLevel1 | String|关键词 | 一级标签|'."\n" + .'|hotwords.labelLevel1 | String|关键词 |二级标签 |'."\n" + .'|hotwords.labelLevel2 |String |"" |二级标签 |'."\n" + .'|hotwords.label |String |中国气象局 |看点词内容 |'."\n" + .'| hotwords.appearanceProbability|double | 0.96|出现率 |'."\n" + .'|hotwords.detailInfo | JSONArray| | |'."\n" + .'| hotwords.detailInfo.score|double | 1.0| 置信度|'."\n" + .'|hotwords.detailInfo.startTime | double|0.021 |开始时间 |'."\n" + .'|hotwords.detailInfo.endTime | double| 29.021|结束时间 |'."\n" + .'| freeTags|JSONArray | | |'."\n" + .'|freeTags.labelLevel1 |String |关键词 |一级标签 |'."\n" + .'|freeTags.labelLevel2 | String| ""| 二级标签|'."\n" + .'|freeTags.label |String |中央气象台 |看点词内容 |'."\n" + .'|freeTags.appearanceProbability |double |0.96 | 出现率|'."\n" + .'|freeTags.detailInfo | JSONArray| | |'."\n" + .'|freeTags.detailInfo.score |double |0.9 | 置信度|'."\n" + .'| freeTags.detailInfo.startTime|double | 0.021| 开始时间|'."\n" + .'|freeTags.detailInfo.endTime |double | 29.021|结束时间 |'."\n" + ."\n" + .'**语音识别ASR结果**'."\n" + .'|名称 | 类型| 描述|'."\n" + .'|---------------|--------|-----------|'."\n" + .'| details|JSONArray | 任务详细结果|'."\n" + .'| details.from| double|开始时间戳，单位（秒） |'."\n" + .'|details.to |double |结束时间戳，单位（秒） |'."\n" + .'| details.content|String |识别出的文本内容 |'."\n" + ."\n" + .'**文本识别OCR结果**'."\n" + .'|名称 |类型 |描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|details |JSONArray |任务详细结果 |'."\n" + .'|details.timestamp |double | 时间戳信息，单位（秒）|'."\n" + .'|details.info | JSONArray|该时间点识别出的具体信息 |'."\n" + .'|details.info.score |double |置信度得分 |'."\n" + .'|details.info.position |JSONObject |文字坐标 |'."\n" + .'|details.info.position.leftTop |int[] | 左上角x，y坐标|'."\n" + .'|details.info.position.rightBottom |int[] |右下角x，y坐标 |'."\n" + .'| details.info.content| String|识别出的文本内容 |'."\n" + ."\n" + .'**Meta标注结果**'."\n" + .'> 如果客户没有使用人机标注，在使用[SubmitSmarttagJob](~~478786~~)提交任务时如果指定了needMetaData，目前QuerySmarttagJob返回结果时会返回原始客户输入的标题。'."\n" + ."\n" + .'|名称 | 类型|描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|title | String| 标题|'."\n" + ."\n" + .'**字幕提取结果Subtitle**'."\n" + .'|名称 |类型 |描述 |'."\n" + .'|---------------|--------|-----------|'."\n" + .'|details |JSONArray |任务详细结果 |'."\n" + .'|details.allResultUrl|String|全部字幕结果URL，URL有效期为任务完成后半年内可有效访问 |'."\n" + .'|details.chResultUrl|String|中文结果URL，URL有效期为任务完成后半年内可有效访问 |'."\n" + .'|details.engResultUrl|String|英文结果URL，URL有效期为任务完成后半年内可有效访问|'."\n" + .'> 字幕结果URL内容：`序号+时间段+字幕内容（每句字幕为一行）`。'."\n" + ."\n" + .'**NLP处理结果**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| transcription | object | 语音转写结果 |'."\n" + .'| autoChapters | object | 章节速览结果 |'."\n" + .'| summarization | object | 大模型摘要结果 |'."\n" + .'| meetingAssistance | object | 智能纪要结果 |'."\n" + .'| translation | object | 文本翻译结果 |'."\n" + ."\n" + .'**transcription（语音转录）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| transcription | object | 语音转写结果对象。 |'."\n" + .'| transcription.paragraphs | list[] | 语音转写结构以段落形式组织的集合。 |'."\n" + .'| transcription.paragraphs[i].paragraphId | string | 段落级别id。 |'."\n" + .'| transcription.paragraphs[i].speakerId | string | 发言人id。 |'."\n" + .'| transcription.paragraphs[i].words | list[] | 该段落包含的word信息。 |'."\n" + .'| transcription.paragraphs[i].words[i].id | int | word序号，通常无须关注。 |'."\n" + .'| transcription.paragraphs[i].words[i].sentenceId | int | 句子id，同属于一个SentenceId的word信息可以组装成一句话。 |'."\n" + .'| transcription.paragraphs[i].words[i].start | long | 该word相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| transcription.paragraphs[i].words[i].end | long | 该word相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| transcription.paragraphs[i].words[i].text | string | word文本。 |'."\n" + ."\n" + .'**summarization（全文摘要、发言人总结、提问摘要）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| summarization | object | 摘要结果对象，可能包含0个或多个不同摘要类型的结果。 |'."\n" + .'| summarization.paragraphSummary | string | 全文摘要结果。 |'."\n" + .'| summarization.conversationalSummary | list[] | 发言总结摘要结果列表。 |'."\n" + .'| summarization.conversationalSummary[i].speakerId | string | 发言人id。 |'."\n" + .'| summarization.conversationalSummary[i].speakerName | string | 发言人名字。 |'."\n" + .'| summarization.conversationalSummary[i].summary | string | 该发言人对应的总结。 |'."\n" + .'| summarization.questionsAnsweringSummary | list[] | 问答摘要结果列表。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].question | string | 问题 |'."\n" + .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfQuestion | list[] | 提炼出该问题对应的原语音转写的SentenceId列表。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].answer | string | 问题对应的答案。 |'."\n" + .'| summarization.questionsAnsweringSummary[i].sentenceIdsOfAnswer | list[] | 总结出该答案对应的原语音转写的SentenceId列表。 |'."\n" + .'| summarization.mindMapSummary | list[object] | 思维导图摘要结果列表，可能包含各个主题的摘要、主题间的关系等。 |'."\n" + .'| summarization.mindMapSummary[i].title | string | 主题的标题。 |'."\n" + .'| summarization.mindMapSummary[i].topic | list[object] | 包含每个主题及其子主题的数组 |'."\n" + .'| summarization.mindMapSummary[i].topic[i].title | string | 主题的标题。 |'."\n" + .'| summarization.mindMapSummary[i].topic[i].topic | list[object] | 主题的子主题数组，可以是空数组。 |'."\n" + ."\n\n" + ."\n" + .' **translation（全文翻译）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| translation | object | 翻译结果对象。 |'."\n" + .'| translation.paragraphs | list[] | 翻译结果以段落形式组织的集合，和语音识别结果报文对应。 |'."\n" + .'| translation.paragraphs.paragraphId | string | 段落分段id标识，和语音识别结果中的ParagraphId对应。 |'."\n" + .'| translation.paragraphs.sentences | list[] | 翻译文本集合。 |'."\n" + .'| translation.paragraphs.sentences[i].sentenctId | long | 句子id。 |'."\n" + .'| translation.paragraphs.sentences[i].start | long | 该段相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| translation.paragraphs.sentences[i].end | long | 该段相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| translation.paragraphs.sentences[i].text | string | 翻译文本，和语音识别结果报文对应。 |'."\n" + ."\n" + .'**autoChapters（章节识别）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| autoChapters | list[] | 章节速览集合， 含有0个、1个或多个章节速览信息。 |'."\n" + .'| autoChapters[i].id | int | 该章节序号。 |'."\n" + .'| autoChapters[i].start | long | 该章节相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| autoChapters[i].end | long | 该章节相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| autoChapters[i].headline | string | 该章节的一句话标题。 |'."\n" + .'| autoChapters[i].summary | string | 章节总结。 |'."\n" + ."\n" + .'**meetingAssistance（智能纪要提取，包含关键词、关键句、待办事项提取）**'."\n" + .'| 参数名 | 类型 | 说明 |'."\n" + .'| --- | --- | --- |'."\n" + .'| meetingAssistance | object | 智能纪要结果对象，可能包含0个或多个不同类型的结果。 |'."\n" + .'| meetingAssistance.keywords | list[] | 关键词提取结果。 |'."\n" + .'| meetingAssistance.keySentences | list[] | 关键句提取结果，也称为重点内容。 |'."\n" + .'| meetingAssistance.keySentences[i].id | long | 关键句序号。 |'."\n" + .'| meetingAssistance.keySentences[i].sentenceId | long | 该关键句在原ASR转写中对应的句子Id。 |'."\n" + .'| meetingAssistance.keySentences[i].start | long | 相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.keySentences[i].end | long | 相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.keySentences[i].text | string | 关键句信息。 |'."\n" + .'| meetingAssistance.actions | list[] | 待办内容、待办摘要的集合。 |'."\n" + .'| meetingAssistance.actions[i].id | long | 待办序号。 |'."\n" + .'| meetingAssistance.actions[i].sentenceId | long | 该关键句在原ASR转写中对应的句子Id。 |'."\n" + .'| meetingAssistance.actions[i].start | long | 相对于音频起始时间的开始时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.actions[i].end | long | 相对于音频起始时间的结束时间，相对时间戳，单位毫秒。 |'."\n" + .'| meetingAssistance.actions[i].text | string | 待办内容。 |'."\n" + .'| meetingAssistance.classifications | object | 场景分类，目前只有3中场景分类。 |'."\n" + .'| meetingAssistance.classifications.interview | float | 面试场景置信度得分。 |'."\n" + .'| meetingAssistance.classifications.lecture | float | 演讲场景置信度得分。 |'."\n" + .'| meetingAssistance.classifications.meeting | float | 会议场景置信度得分。 |', + ], + 'SubmitSmarttagJob' => [ + 'summary' => '提交智能标签作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '视频标题，支持中英文、数字、中划线（-），不能以特殊符号开头，长度不能超过256B。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'example-title-**** '."\n", + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '视频内容描述，支持中英文、数字、中划线（-），不能以特殊符号开头，长度不能超过1KB。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'example content **** '."\n", + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + ], + ], + [ + 'name' => 'ContentAddr', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '额外的请求参数，使用JSON字符串表示，例如：{"needAsrData":true, "needOcrData":false}。字段说明：'."\n" + ."\n" + .'- needAsrData：boolean值，分析结果中是否需要包含原始ASR结果，默认false（不包含），可选true（包含）'."\n" + ."\n" + .'- needOcrData：boolean值，分析结果中是否需要包含原始OCR结果，默认false（不包含），可选true（包含）'."\n" + ."\n" + .'- needMetaData：boolean值，分析结果中是否需要包含Meta信息，默认false（不包含），可选true（包含）'."\n" + ."\n" + .'- nlpParams: JsonObject值，nlp算子的输入参数，默认为空（不使用nlp算子），详见下方请求参数补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => '{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}'."\n", + ], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Callback路径，目前仅支持http/https。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com/endpoint/aliyun/ai?id=76401125000***', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '通过MNS回调时透传回来的信息，长度不能超过1KB。如何设置MNS回调队列。', + 'type' => 'string', + 'required' => false, + 'example' => '{“a”:"test"}', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'input', + 'description' => 'input', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体类型，包含以下三种类型：'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- Media'."\n" + ."\n" + .'- URL', + 'type' => 'string', + 'required' => false, + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '- 上述Type参数设置为OSS时，写OSS地址，例如：OSS://test-bucket/video/202208/test.mp4'."\n" + ."\n" + .'- Type为Media时写mediaId：c5c62d8f0361337cab312dce8e77dc6d'."\n" + ."\n" + .'- Type为URL时写http url，例如：https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4', + 'type' => 'string', + 'required' => false, + 'example' => 'c5c62d8f0361337cab312dce8e77dc6d', + ], + ], + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID用于指定分析算法，模板相关操作参见[统一模版配置](~~445702~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '39f8e0bc005e4f309379701645f4'."\n", + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'scheduleConfig', + 'description' => 'scheduleConfig', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID，用于区分业务，绑定消息通知。'."\n" + ."\n" + .'未配置该参数时表示默认管道。默认管道并发为2，需要提升并发数请提交工单。', + 'type' => 'string', + 'required' => false, + 'example' => 'acdbfe4323bcfdae', + ], + 'Priority' => [ + 'description' => '优先级，暂时未实现，可以不填或随便填。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TemplateConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '启动任务时动态传入的模板参数，用于临时覆盖或补充由 TemplateId 对应模板中的已配置参数。服务端会将该参数与模板原参数按字段进行合并，生成本次任务的最终模板配置，并在执行前进行校验。'."\n" + ."\n" + .'- 合并规则：'."\n" + .'1. 如果字段在模板中已存在 → 使用调用方的值覆盖模板值（调用方优先）'."\n" + .'2. 如果字段在模板中不存在 → 追加为新的字段'."\n" + ."\n" + .'- 当前支持的动态字段：'."\n" + ."\n" + .'1. FaceCategoryIds：参与识别的人脸库 ID 列表（用英文逗号 , 分隔，可以包含系统库 ID 与自定义库 ID）'."\n" + ."\n" + .'- 注意事项：'."\n" + .' 仅影响本次任务执行，不会修改模板本身', + 'type' => 'string', + 'required' => false, + 'example' => '{"FaceCategoryIds":"custom_face_lib1"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '智能标签作业ID。建议您保存此ID便于后续调用其他接口时使用。'."\n" + ."\n", + 'type' => 'string', + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****d80e4e4044975745c14b****\\"\\n}","type":"json"}]', + 'title' => '提交智能标签作业', + 'description' => '### 前提条件'."\n" + .'通过本接口提交智能标签作业时，需要先通过模板配置分析类型。具体操作请参见[CreateCustomTemplate](~~441184~~)。'."\n" + .'### 使用限制'."\n" + ."\n" + .'- 智能标签功能，目前开通的地域为华北2（北京）、华东2（上海）、华东1（杭州），其他地域暂不支持。'."\n" + ."\n" + .'- 目前智能标签管道默认并发数为2，如有更高需求，请[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c4g.11186623.0.0.645019b6Btnu4q)联系阿里云客服进行评估配置。'."\n" + ."\n" + .'- 智能标签任务和相关结果保留180天，超过会自动清理。', + 'requestParamsDescription' => '### nlpParams说明'."\n" + .'| 功能 | 名称 | 类型 | 必填 | 描述 | 示例值 |'."\n" + .'| --- | --- | --- | --- | --- | --- |'."\n" + .'| | nlpParams | object | 是 | 该参数包含了所有nlp处理的相关参数，template分析类型包含nlp的时候必填，否则任务失败。 | {"sourceLanguage":"cn"}|'."\n" + .'| 转录| sourceLanguage | string | 是 | 转写使用的源语言模型，可选：cn（中文）、en（英文）、 yue（粤语）、 fspk（中英文自由说）、ja（日语）。若语音中的语种非单语种，涉及多个语种，可传入（multilingual），识别出对应语种的文字。结合Input.LanguageHints一起使用。仅支持16k音频。 | "cn" |'."\n" + .'| | languageHints | list[string] | 否 | [指定多语言模型时需语音识别出文字的语种列表](https://help.aliyun.com/zh/tingwu/offline-transcribe-of-audio-and-video-files?spm=a2c4g.11186623.help-menu-454189.d_2_1_0.72df7a7eLXlL19&scm=20140722.H_2609582._.OR_help-T_cn~zh-V_1#c49c0bf020mpj)。参数值可配置（可多选）： 中文（cn）， 英语（en）， 粤语（yue）， 日语（ja）、韩语（ko）、德语（de）、法语（fr）、俄语（ru）。当语音中涉及多个语种的语音均需识别出文字时，此参数用于限制语种类别，同时避免误识别出场景无关的语种。且仅当Input.SourceLanguage=\'multilingual\'时配置生效。 | [\'cn\', \'en\', \'yue\'] |'."\n" + .'| | transcriptionModel | string | 否 | 指定所使用的转录模型名称。可选值： fun-asr：必须配合sourceLanguage=multilingual使用！。 | fun-asr |'."\n" + .'| | diarizationEnabled | boolean | 否 | 是否开启说话人分离功能，默认false。 | true |'."\n" + .'| | speakerCount | integer | 否 | 设置说话人分离参数。 不设置：不使用说话人角色区分。0：说话人角色区分结果为不定人数。2：说话人角色区分结果为2人。 | 2 |'."\n" + .'| 热词| phraseId | string | 否 | 热词的词表 ID。 | ce9c2a34b6d847bf92a77d0a196f*** |'."\n" + .'| PPT抽取总结 | pptExtractionEnabled | boolean | 否 | 是否启用 PPT 抽取和 PPT 总结功能，开启后会对视频文件中的 PPT 进行画面抽取，并形成对应的总结，默认false。 | true |'."\n" + .'| 摘要 | summarizationEnabled | boolean | 否 | 是否启用摘要功能，开启后会可以生成全文摘要、发言人总结等结果。| true |'."\n" + .'| | summarizationTypes | string | 否 | 开启摘要功能时，需传入期望的摘要类型：Paragraph（全文摘要）、Conversational（发言人总结）、QuestionsAnswering（问答摘要）、MindMap（思维导图）。| "Paragraph,Conversational,QuestionsAnswering,MindMap" |'."\n" + .'| 翻译 | translationEnabled | boolean | 否 | 是否启用翻译功能。 | true |'."\n" + .'| | targetLanguages | string | 否 | 开启翻译功能后的目标语言，可选：cn（中文）、en（英文）、 yue（粤语）、 fspk（中英文自由说）。| "en,cn" |'."\n" + .'| 章节识别 | autoChaptersEnabled | boolean | 否 | 是否启用章节速览功能，结果包含章节标题、章节摘要。 | true |'."\n" + .'| 智能纪要 | meetingAssistanceEnabled | boolean | 否 | 是否开启会议协助功能，结果包含分类、关键词、关键句、待办事项。 | true |', + 'extraInfo' => '访问错误中心查看更多错误码。', + ], + 'CreateRecognitionEntity' => [ + 'summary' => '在指定的自定义识别库中创建一个新的待识别实体。通过该接口可以添加自定义地标、物体、台标、人物等识别实体。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID，可调用[ListRecognitionLibs](~~2926699~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*************24b47865c6**************', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义识别实体名称，最长支持 64 字节。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '自定义库实体名称'."\n", + ], + ], + [ + 'name' => 'EntityInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义识别实体的额外信息，JSON String 类型，最长支持 256 字节。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"description": "图书分类"} ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EntityId' => [ + 'description' => '创建成功的实体ID', + 'type' => 'string', + 'example' => '**************544cb84754************', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EntityId\\": \\"**************544cb84754************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '创建自定义识别库中的待识别实体', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'CreateRecognitionLib' => [ + 'summary' => '创建一个新的自定义识别库，用于存储待识别的实体信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibName', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库名称，最长支持 64 字节。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark测试库', + ], + ], + [ + 'name' => 'LibDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库描述信息，最长支持 128 字节。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '用于存储商品识别样本', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'LibId' => [ + 'description' => '创建成功的识别库ID', + 'type' => 'string', + 'example' => '*************24b47865c6**************', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LibId\\": \\"*************24b47865c6**************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '创建自定义识别库', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 自注册识别库使用方法（以object 为例）：分别创建自定义 object 库、自定义 obiect 实体，创建完成后注册自定义 object 实体图片，注册完成后创建包含自注册 object 库的模板 A，再使用模板 A 提交分析任务，最终查询结果。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'CreateRecognitionSample' => [ + 'summary' => '为指定的自定义实体添加识别样本图片或者文本标签，用于后续的识别匹配。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*************24b47865c6**************', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '**************544cb84754************', + ], + ], + [ + 'name' => 'ImageUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '样本图片的URL地址', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'https://example.com/sample.png', + ], + ], + [ + 'name' => 'LabelPrompt', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义标签文本提示词', + 'type' => 'string', + 'required' => false, + 'example' => '正面完整视图', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SampleId' => [ + 'description' => '创建成功的样本ID', + 'type' => 'string', + 'example' => '**************4d2ba728e2f**************', + ], + 'RequestId' => [ + 'description' => '请求 Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SampleId\\": \\"**************4d2ba728e2f**************\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '注册自定义实体的识别样本', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'ListRecognitionSamples' => [ + 'summary' => '分页查询指定实体下的所有识别样本信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '库ID，传入则精确查该库；支持传入列表，用","分割。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lib1,lib2,lib3', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID。填"ANY"时，会查询EntityName。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '**************544cb84754************', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => ' 每页返回的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体名。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom_person', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => ' 每页返回的记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '样本总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Samples' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Sample' => [ + 'description' => '样本列表 ', + 'type' => 'array', + 'items' => [ + 'description' => '样本', + 'type' => 'object', + 'properties' => [ + 'SampleId' => [ + 'description' => '样本ID。', + 'type' => 'string', + 'example' => '**************4d2ba728e2f**************', + ], + 'ImageUrl' => [ + 'description' => '样本图片URL', + 'type' => 'string', + 'example' => 'https://example.com/sample.png', + ], + 'EntityId' => [ + 'description' => '实体id', + 'type' => 'string', + 'example' => '*******49ff-9b15******', + ], + 'LibId' => [ + 'description' => '实体库id', + 'type' => 'string', + 'example' => '**********23da4529998************', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Samples\\": {\\n \\"Sample\\": [\\n {\\n \\"SampleId\\": \\"**************4d2ba728e2f**************\\",\\n \\"ImageUrl\\": \\"https://example.com/sample.png\\",\\n \\"EntityId\\": \\"*******49ff-9b15******\\",\\n \\"LibId\\": \\"**********23da4529998************\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取自定义实体的识别样本列表', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'DeleteRecognitionSample' => [ + 'summary' => '从指定的自定义实体中删除一个识别样本。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*************24b47865c6**************', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '**************544cb84754************', + ], + ], + [ + 'name' => 'SampleId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的样本ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '**************4d2ba728e2f**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除自定义实体的识别样本', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'ListRecognitionEntities' => [ + 'summary' => '分页查询指定识别库中的所有实体信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1965304870001', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。单页最大数量不超过 50。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PageNumber' => [ + 'description' => '页码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Entities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Entity' => [ + 'description' => '实体列表', + 'type' => 'array', + 'items' => [ + 'description' => '实体', + 'type' => 'object', + 'properties' => [ + 'EntityId' => [ + 'description' => '实体ID', + 'type' => 'string', + 'example' => '**************544cb84754************', + ], + 'EntityName' => [ + 'description' => '实体名称', + 'type' => 'string', + 'example' => '巴黎铁塔', + ], + 'EntityInfo' => [ + 'description' => '实体附加信息（JSON格式）', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Entities\\": {\\n \\"Entity\\": [\\n {\\n \\"EntityId\\": \\"**************544cb84754************\\",\\n \\"EntityName\\": \\"巴黎铁塔\\",\\n \\"EntityInfo\\": \\"{}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取自定义识别库中的实体列表', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'ListRecognitionLibs' => [ + 'summary' => '分页查询当前用户下的所有自定义识别库信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。单页数量最大不超过 50。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '库ID，传入则精确查该库；支持传入列表，用","分割。', + 'type' => 'string', + 'required' => false, + 'example' => 'lib1,lib2,lib3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PageNumber' => [ + 'description' => '页码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '180', + ], + 'Libs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Lib' => [ + 'description' => '识别库列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LibId' => [ + 'description' => '识别库ID', + 'type' => 'string', + 'example' => '*************24b47865c6**************', + ], + 'LibName' => [ + 'description' => '识别库名称', + 'type' => 'string', + 'example' => '大模型acp', + ], + 'LibDescription' => [ + 'description' => '识别库描述信息', + 'type' => 'string', + 'example' => '用于商品识别的库', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 180,\\n \\"Libs\\": {\\n \\"Lib\\": [\\n {\\n \\"LibId\\": \\"*************24b47865c6**************\\",\\n \\"LibName\\": \\"大模型acp\\",\\n \\"LibDescription\\": \\"用于商品识别的库\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取自定义识别库列表', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'DeleteRecognitionLib' => [ + 'summary' => '删除指定的自定义识别库，包括库中的所有实体和样本数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*************24b47865c6**************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除自定义识别库', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'DeleteRecognitionEntity' => [ + 'summary' => '从指定的自定义识别库中删除一个已存在的识别实体。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Algorithm', + 'in' => 'query', + 'schema' => [ + 'description' => '识别类型，取值：'."\n" + ."\n" + .'- landmark：自定义地标。'."\n" + ."\n" + .'- object：自定义物体。'."\n" + ."\n" + .'- logo：自定义logo'."\n" + ."\n" + .'- face：自定义人脸'."\n" + ."\n" + .'- label：自定义标签', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'landmark', + ], + ], + [ + 'name' => 'LibId', + 'in' => 'query', + 'schema' => [ + 'description' => '识别库ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '*************24b47865c6**************', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的实体ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '**************544cb84754************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'errorMsg:%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'errorMsg:%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除自定义识别库中的实体', + 'description' => '- 本接口目前支持的地域为华北2（北京）、华东2（上海）、华东1（杭州）、华南1（深圳），其他地域暂不支持。'."\n" + ."\n" + .'- 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](~~342832~~)。', + ], + 'SubmitIProductionJob' => [ + 'summary' => '调用SubmitIProductionJob提交智能生产任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称，长度不超过100字符。', + 'type' => 'string', + 'required' => false, + 'example' => '测试任务', + ], + ], + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要使用的算法功能名称。取值：'."\n" + ."\n" + .'- **Cover**：智能封面'."\n" + .'- **VideoClip**：视频摘要'."\n" + .'- **VideoDelogo**：视频去图标'."\n" + .'- **VideoDetext**：视频去字幕'."\n" + .'- **CaptionExtraction**：字幕提取'."\n" + .'- **VideoGreenScreenMatting**：绿幕抠图'."\n" + .'- **FaceBeauty**：视频美颜'."\n" + .'- **VideoH2V**：视频横转竖'."\n" + .'- **MusicSegmentDetect**：副歌检测'."\n" + .'- **AudioBeatDetection**：节奏检测'."\n" + .'- **AudioQualityAssessment**：音质检测'."\n" + .'- **SpeechDenoise**：语音降噪'."\n" + .'- **AudioMixing**：音频混音'."\n" + .'- **MusicDemix**：声伴分离', + 'type' => 'string', + 'required' => true, + 'example' => 'Cover', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入媒体，支持OSS或媒资ID。'."\n" + ."\n" + .'不同算法功能Input输入的文件要求不同，详见下方补充说明。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体类型：'."\n" + ."\n" + .'- OSS：OSS路径'."\n" + ."\n" + .'- Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体，支持OSS地址和媒资ID两种。'."\n" + .'oss地址规则为：（两种形式选一种即可）'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输出媒体，支持OSS或媒资ID。'."\n" + ."\n" + .'不同算法功能Output输出的文件不同，详见下方补充说明。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体类型：'."\n" + ."\n" + .'- OSS：OSS路径'."\n" + ."\n" + .'- Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Biz' => [ + 'description' => '媒资所属业务', + 'type' => 'string', + 'required' => false, + 'example' => 'IMS', + 'enum' => [ + 'IMS', + 'VOD', + ], + ], + 'Media' => [ + 'description' => '输出媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + ."\n" + .'OSS地址规则为：（两种形式选一种即可）'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。'."\n" + ."\n" + .'媒资ID：'."\n" + .' '."\n" + .'- 支持指定已有MediaId'."\n" + .' - 不需要指定Biz，随源'."\n" + ."\n" + .'- 支持新建MediaId（MediaId为空）'."\n" + .' - 根据Biz决定写入IMS还是VOD媒资，未指定Biz默认随源或IMS'."\n" + ."\n" + .'> OSS地址路径支持占位符，如：oss://example-****/iproduction/{source}-{timestamp}-{sequenceId}.png。当前支持以下几种占位符：'."\n" + .'> - {source}：填充输入文件名'."\n" + .'> - {timestamp}：填充Unix时间戳'."\n" + .'> - {sequenceId}：填充生成序号'."\n" + .'> - {resultType}：填充输出文件类型（服务端决定）'."\n" + .'> 占位符不必须，但对于多输出算法，比如智能封面等，需要注意加入序号占位符确保输出文件路径不重复。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + 'OutputUrl' => [ + 'description' => '当Type=Media时，指定输出文件OSS地址。bucket必须注册在IMS或VOD中。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'http(s)://bucket.oss-[RegionId].aliyuncs.com/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'JobParams', + 'in' => 'query', + 'schema' => [ + 'description' => '算法作业参数，JSON对象，不同算法对应参数内容不同。详见补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Model":"gif"}', + ], + ], + [ + 'name' => 'ScheduleConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务调度配置信息', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'required' => false, + 'example' => '5246b8d12a62433ab77845074039c3dc', + ], + 'Priority' => [ + 'description' => '取值范围为1到10，数值越小优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，获取结果时原样返回。长度不超过256字符。', + 'type' => 'string', + 'required' => false, + 'example' => '{"test":1}', + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '算法模型 ID。如果为空，则选择对应功能的默认模型（此参数保持为空即可，一般无需传入，直接使用默认模型）。'."\n" + ."\n" + .'当前有以下算法功能存在非默认模型可供选择：'."\n" + .'* VideoDetext'."\n" + .' * ModelId = algo-video-detext-new，效果更好的字幕擦除算法，速度比默认算法慢，费用比默认算法高', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C1849434-FC47-5DC1-92B6-F7EAAFE3851E', + ], + 'JobId' => [ + 'description' => '智能任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C1849434-FC47-5DC1-92B6-F7EAAFE3851E\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交智能生产任务', + 'requestParamsDescription' => '## Input和Output字段说明'."\n" + ."\n" + .'### Cover'."\n" + ."\n" + .'输入一个视频文件，输出若干张图片（默认3张，需要通过占位符区分），格式为png或gif（取决于JobParams中参数，生成静态图或动态图）。'."\n" + ."\n" + .'### VideoDelogo'."\n" + ."\n" + .'输入一个视频文件，输出擦除图标后的视频（格式为mp4）。'."\n" + ."\n" + .'### VideoDetext'."\n" + ."\n" + .'输入一个视频文件，输出擦除字幕后的视频（格式为mp4）。'."\n" + ."\n" + .'### CaptionExtraction'."\n" + ."\n" + .'输入一个视频文件，输出字幕文件（SRT格式）。'."\n" + ."\n" + .'### VideoGreenScreenMatting'."\n" + ."\n" + .'输入一个视频文件，输出绿幕抠图后的视频（格式为mp4或webm，取决于JobParams参数）。'."\n" + ."\n" + .'### FaceBeauty'."\n" + ."\n" + .'输入一个视频文件，输出美颜后的视频（格式为mp4）。'."\n" + ."\n" + .'### VideoH2V'."\n" + ."\n" + .'输入一个视频文件，输出横转竖后的视频（格式为mp4）。'."\n" + ."\n" + .'### MusicSegmentDetect'."\n" + ."\n" + .'输入一个音频文件，输出副歌检测后的结果信息文件（Json格式）。'."\n" + ."\n" + .'### AudioBeatDetection'."\n" + ."\n" + .'输入一个音频文件，输出节奏检测后的结果信息文件（Json格式）。'."\n" + ."\n" + .'### AudioQualityAssessment'."\n" + ."\n" + .'输入一个音频文件，无输出文件。音质检测结果放在QueryIProductionJob中直接返回。'."\n" + ."\n" + .'### SpeechDenoise'."\n" + ."\n" + .'输入一个音频文件，输出降噪后的音频（格式为wav）。'."\n" + ."\n" + .'### AudioMixing'."\n" + ."\n" + .'输入一个待混音的音频文件，输出混音后的音频（格式为wav）。混入的音频文件如何输入详见下面的JobParams参数。'."\n" + ."\n" + .'### MusicDemix'."\n" + ."\n" + .'输入一个音频文件（歌曲），输出声伴分离后的两个音频（Output路径中需要传入{resultType}占位符，分别代表人声和背景声）。'."\n" + ."\n" + .'## JobParams的JSON字段说明'."\n" + ."\n" + .'### Cover'."\n" + ."\n" + .'* Model：String类型，智能封面模型，为空时输出图片封面，为gif时输出动图封面。'."\n" + ."\n" + .'### VideoDelogo'."\n" + ."\n" + .'* LogoModel：String类型，去除的logo类型，取值：tv（通用台标 - 电视台），internet（通用台标 - 网络媒体），该字段可多选，通过逗号分隔。'."\n" + .'* Boxes：String类型，目标logo框位置，以左上角为原点的归一化距离，[xmin, ymin, width, height]，目前最多支持两个目标logo框，例如："[[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]]"。'."\n" + ."\n" + .'### VideoDetext'."\n" + ."\n" + .'* LimitRegion：list类型，限定字幕检测区域，以左上角为原点的归一化距离，[xmin, ymin, width, height]，可支持多个检测区域，例如：[[0, 0, 0.3, 0.3], [0.7, 0, 0.3, 0.3]]。**注意，不设置该参数时，默认检测区域为视频下方30%区域。**'."\n" + .'* Time：指定全局擦除时间（单位s），list类型，包括起始时间和结束时间，[start_time, end_time]，例如[5, 20]，表示只擦除视频的5~20秒之间的字幕。'."\n" + .' * Time参数可以是一维数组，如[5, 20]，指定一个时间段'."\n" + .' * Time参数也可以是二维数组，如[[5, 20], [25, 43], [51, 80]]，指定多个时间段（只有当modelId=algo-video-detext-new时支持）'."\n" + ."\n" + .'### CaptionExtraction'."\n" + ."\n" + .'* fps：采样帧率（可选），整数，取值范围为[2,10]，默认5。'."\n" + .'* roi：字幕框选区域（只对区域内的字幕进行提取），格式：[[top, bottom], [left, right]]，为归一化取值（如下半部分[[0.5, 1], [0, 1]]）。不传此值，默认识别视频底部1/4区域。'."\n" + .'* lang：识别语言，ch（中文）、en（英文），ch_ml（中英混合）。默认ch。'."\n" + .'* track：如果传"main"，表示只提取主字幕轨道。不传时，默认提取区域内出现的所有字幕。'."\n" + ."\n" + .'### VideoGreenScreenMatting'."\n" + ."\n" + .'* bgimage：抠图后叠加的背景图片，例如：http://example-image-****.example-location.aliyuncs.com/example/example.jpg。如果不传该参数，则输出带透明通道的WEBM视频。'."\n" + ."\n" + .'### FaceBeauty'."\n" + ."\n" + .'* beauty_params：美颜功能参数，填写示例： "whiten=20,smooth=50,face_thin=50"，详见[参数字段说明](~~352026#section-2b1-xzo-9dg~~)'."\n" + ."\n" + .'### VideoH2V'."\n" + ."\n" + .'无'."\n" + ."\n" + .'### MusicSegmentDetect'."\n" + ."\n" + .'无'."\n" + ."\n" + .'### AudioBeatDetection'."\n" + ."\n" + .'无'."\n" + ."\n" + .'### AudioQualityAssessment'."\n" + ."\n" + .'无'."\n" + ."\n" + .'### SpeechDenoise'."\n" + ."\n" + .'输入音频要求：格式需为WAV，采样率为16khz或48khz。'."\n" + ."\n" + .'### AudioMixing'."\n" + ."\n" + .'* inputs：待混合的音轨文件地址列表，目前只支持一个，例如：{"file":"http://example-bucket-****.oss-cn-shanghai.aliyuncs.com/2.mp4"}'."\n" + ."\n" + .'### MusicDemix'."\n" + ."\n" + .'无', + ], + 'QueryIProductionJob' => [ + 'summary' => '调用QueryIProductionJob查询智能生产任务状态与结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能任务ID', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => '测试任务', + ], + 'FunctionName' => [ + 'description' => '需要使用的算法功能名称。取值：'."\n" + ."\n" + .'- **Cover**：智能封面'."\n" + .'- **VideoClip**：视频摘要'."\n" + .'- **VideoDelogo**：视频去图标'."\n" + .'- **VideoDetext**：视频去字幕'."\n" + .'- **CaptionExtraction**：字幕提取'."\n" + .'- **VideoGreenScreenMatting**：绿幕抠图'."\n" + .'- **FaceBeauty**：视频美颜'."\n" + .'- **VideoH2V**：视频横转竖'."\n" + .'- **MusicSegmentDetect**：副歌检测'."\n" + .'- **AudioBeatDetection**：节奏检测'."\n" + .'- **AudioQualityAssessment**：音质检测'."\n" + .'- **SpeechDenoise**：语音降噪'."\n" + .'- **AudioMixing**：音频混音'."\n" + .'- **MusicDemix**：声伴分离', + 'type' => 'string', + 'example' => 'Cover', + ], + 'Input' => [ + 'description' => '输入媒体', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。'."\n" + .'OSS地址规则为：'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'Output' => [ + 'description' => '输出媒体', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体类型：'."\n" + .'- OSS：OSS路径'."\n" + .'- Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Biz' => [ + 'description' => '媒资所属业务', + 'type' => 'string', + 'enumValueTitles' => [ + 'VOD' => 'VOD', + 'IMS' => 'IMS', + ], + 'example' => 'IMS', + ], + 'Media' => [ + 'description' => '输出媒体。当Type为OSS时返回OSS地址，Type为Media时返回指定的媒资ID或新生成媒资ID。'."\n" + ."\n" + .'OSS地址规则为：'."\n" + .'1. oss://bucket/object'."\n" + .'2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object'."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + 'OutputUrl' => [ + 'description' => '当Type=Media时，为指定输出文件OSS地址', + 'type' => 'string', + 'example' => 'http(s)://bucket.oss-[RegionId].aliyuncs.com/object ', + ], + ], + ], + 'TemplateId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => '****96e8864746a0b6f3****', + ], + 'JobParams' => [ + 'description' => '算法作业参数，JSON对象，不同算法对应参数内容不同。', + 'type' => 'string', + 'example' => '{"Model":"gif"}', + ], + 'ScheduleConfig' => [ + 'description' => '任务配置信息', + 'type' => 'object', + 'properties' => [ + 'PipelineId' => [ + 'description' => '管道ID', + 'type' => 'string', + 'example' => 'a54fdc9c9aab413caef0d1150f565e86', + ], + 'Priority' => [ + 'description' => '任务在其对应管道内的优先级。'."\n" + ."\n" + .'- 最高优先级：10。'."\n" + ."\n" + .'- 默认值：**6**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + 'UserData' => [ + 'description' => '用户自定义数据，获取结果时原样返回', + 'type' => 'string', + 'example' => '{"test":1}', + ], + 'Result' => [ + 'description' => '算法输出的结果信息，不同FunctionName的输出不同，以JSON格式输出，详见下面的补充说明', + 'type' => 'string', + 'example' => '{}', + ], + 'CreateTime' => [ + 'description' => '创建时间，GMT时间', + 'type' => 'string', + 'example' => '2022-07-07T07:16:11Z', + ], + 'FinishTime' => [ + 'description' => '完成时间，GMT时间', + 'type' => 'string', + 'example' => '2021-11-26T14:50:25Z', + ], + 'Status' => [ + 'description' => '作业状态。取值：'."\n" + .'- Queuing：排队中。'."\n" + .'- Analysing：分析中。'."\n" + .'- Fail：失败。'."\n" + .'- Success：成功。', + 'type' => 'string', + 'example' => 'Success', + ], + 'OutputFiles' => [ + 'description' => '输出文件数组', + 'type' => 'array', + 'items' => [ + 'description' => '生成的文件路径与名称', + 'type' => 'string', + 'example' => 'output/xxx.mp4', + ], + ], + 'OutputMediaIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'OutputUrls' => [ + 'description' => '输出文件URL数组', + 'type' => 'array', + 'items' => [ + 'description' => '生成的文件可访问URL路径', + 'type' => 'string', + 'example' => 'http://xxx', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Name\\": \\"测试任务\\",\\n \\"FunctionName\\": \\"Cover\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Biz\\": \\"IMS\\",\\n \\"Media\\": \\"oss://bucket/object\\",\\n \\"OutputUrl\\": \\"http(s)://bucket.oss-[RegionId].aliyuncs.com/object \\"\\n },\\n \\"TemplateId\\": \\"****96e8864746a0b6f3****\\",\\n \\"JobParams\\": \\"{\\\\\\"Model\\\\\\":\\\\\\"gif\\\\\\"}\\",\\n \\"ScheduleConfig\\": {\\n \\"PipelineId\\": \\"a54fdc9c9aab413caef0d1150f565e86\\",\\n \\"Priority\\": 6\\n },\\n \\"UserData\\": \\"{\\\\\\"test\\\\\\":1}\\",\\n \\"Result\\": \\"{}\\",\\n \\"CreateTime\\": \\"2022-07-07T07:16:11Z\\",\\n \\"FinishTime\\": \\"2021-11-26T14:50:25Z\\",\\n \\"Status\\": \\"Success\\",\\n \\"OutputFiles\\": [\\n \\"output/xxx.mp4\\"\\n ],\\n \\"OutputMediaIds\\": [\\n \\"\\"\\n ],\\n \\"OutputUrls\\": [\\n \\"http://xxx\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询智能生产任务', + 'responseParamsDescription' => '### Result示例说明'."\n" + ."\n" + .'#### Cover'."\n" + ."\n" + .'示例：[{"Score":8.270855992569906,"Time":"28278.25","Url":"cover/test-00001.jpg"},{"Score":7.474117489692728,"Time":"25942.583333333332","Url":"cover/test-00002.jpg"}]'."\n" + ."\n" + .'其中Score为封面结果置信度，Time为封面帧时间戳，Url为封面文件路径。'."\n" + ."\n" + .'#### VideoClip'."\n" + ."\n" + .'示例：{"VideoSummaryList":[{"EndTime":"5.28","StartTime":"0.28"}]}'."\n" + ."\n" + .'其中VideoSummaryList是个列表，表示从原视频中截取的时间段，单位为秒'."\n" + ."\n" + .'#### VideoDelogo'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### VideoDetext'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### CaptionExtraction'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### VideoGreenScreenMatting'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### FaceBeauty'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### VideoH2V'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### MusicSegmentDetect'."\n" + ."\n" + .'示例：[{"start":39.32,"end":63.85,"title":"副歌"},{"start":86.69,"end":114.45,"title":"副歌"},{"start":135.75,"end":160.27,"title":"副歌"}]'."\n" + ."\n" + .'#### AudioBeatDetection'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### AudioQualityAssessment'."\n" + ."\n" + .'示例：'."\n" + .'[{'."\n" + .' "Discontinuity":"Good",'."\n" + .' "Loudness":"Excellent",'."\n" + .' "Worst MOS(0-5)":"0.38",'."\n" + .' "Discontinuity(0-5)":"3.52",'."\n" + .' "Speech Ratio":"48.55",'."\n" + .' "Loudness(0-5)":"4.91",'."\n" + .' "Worst Discontinuity(0-5)":"0.88",'."\n" + .' "Worst Coloration(0-5)":"0.42",'."\n" + .' "Channel":"1",'."\n" + .' "Coloration(0-5)":"0.99",'."\n" + .' "Bad Mute Ratio(%)":"0.0",'."\n" + .' "Time":"2022-12-02 16:14:06",'."\n" + .' "Noisiness(0-5)":"3.28",'."\n" + .' "MOS":"Poor",'."\n" + .' "Worst Noisiness(0-5)":"0.91",'."\n" + .' "Double Talk Ratio(%)":"19.23",'."\n" + .' "Input":"/home/admin/algo/quality****/example.wav",'."\n" + .' "Total Duration":"42.78",'."\n" + .' "Noisiness":"Good",'."\n" + .' "Tag":"Valid",'."\n" + .' "MOS(0-5)":"1.01",'."\n" + .' "Loudness(-90dB-0dB)":"-0.59",'."\n" + .' "Coloration":"Bad",'."\n" + .' "Saturated Ratio(%)":"37.55"'."\n" + .' },'."\n" + .' {'."\n" + .' "Discontinuity":"Fair",'."\n" + .' "Loudness":"Excellent",'."\n" + .' "Worst MOS(0-5)":"0.65",'."\n" + .' "Discontinuity(0-5)":"2.45",'."\n" + .' "Speech Ratio":"41.68",'."\n" + .' "Loudness(0-5)":"4.52",'."\n" + .' "Worst Discontinuity(0-5)":"0.66",'."\n" + .' "Worst Coloration(0-5)":"0.72",'."\n" + .' "Channel":"2",'."\n" + .' "Coloration(0-5)":"2.34",'."\n" + .' "Bad Mute Ratio(%)":"0.0",'."\n" + .' "Time":"2022-12-02 16:14:06",'."\n" + .' "Noisiness(0-5)":"2.53",'."\n" + .' "MOS":"Poor",'."\n" + .' "Worst Noisiness(0-5)":"0.67",'."\n" + .' "Double Talk Ratio(%)":"25.93",'."\n" + .' "Input":"/home/admin/algo/quality****/example.wav",'."\n" + .' "Total Duration":"42.78",'."\n" + .' "Noisiness":"Fair",'."\n" + .' "Tag":"Valid",'."\n" + .' "MOS(0-5)":"1.69",'."\n" + .' "Loudness(-90dB-0dB)":"-4.82",'."\n" + .' "Coloration":"Fair",'."\n" + .' "Saturated Ratio(%)":"0.0"'."\n" + .' }]'."\n" + ."\n" + .'[参数字段解释](~~352026#section-1vi-l8s-fhd~~)'."\n" + ."\n\n" + .'#### SpeechDenoise'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### AudioMixing'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出'."\n" + ."\n" + .'#### MusicDemix'."\n" + ."\n" + .'示例：{}'."\n" + ."\n" + .'算法无额外信息输出', + ], + 'CreateDNADB' => [ + 'summary' => '调用CreateDNADB创建DNA库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'example name', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库模型。包含：'."\n" + .'- **Video**：视频'."\n" + .'- **Audio**：音频'."\n" + .'- **Image**：图片'."\n" + .'- **Text**：文本【仅上海区域支持】', + 'type' => 'string', + 'required' => false, + 'example' => 'Video', + 'default' => '1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库描述。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个视频DNA库。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'DBInfo' => [ + 'description' => 'DNA库详细信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'DNA库描述。', + 'type' => 'string', + 'example' => '这是一个视频DNA库。', + ], + 'Name' => [ + 'description' => 'DNA库名称。', + 'type' => 'string', + 'example' => 'example name', + ], + 'Status' => [ + 'description' => 'DNA库的状态。新建成功后默认为offline状态，待后台处理完成后会自动转换成active状态。', + 'type' => 'string', + 'example' => 'offline', + ], + 'DBId' => [ + 'description' => 'DNA库ID。建议您保存此ID便于后续调用其他相关接口时使用。', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + 'Model' => [ + 'description' => 'DNA库模型。', + 'type' => 'string', + 'example' => 'Video', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"DBInfo\\": {\\n \\"Description\\": \\"这是一个视频DNA库。\\",\\n \\"Name\\": \\"example name\\",\\n \\"Status\\": \\"offline\\",\\n \\"DBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\",\\n \\"Model\\": \\"Video\\"\\n }\\n}","type":"json"}]', + 'title' => '创建DNA库', + 'description' => '单个用户默认可以创建指纹库个数为5个，如需提高，请[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?spm=a2c4g.11186623.0.0.645019b6Btnu4q)申请。无用指纹库可以调用DeleteDNADB接口删除。', + ], + 'DeleteDNADB' => [ + 'summary' => '调用DeleteDNADB删除DNA库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DBId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的DNA库Id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', + 'title' => '删除DNA库', + ], + 'ListDNADB' => [ + 'summary' => '调用ListDNADB查询DNA库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146937', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库ID列表。⼀次建议最多查10个，ID之间⽤半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '2288c6ca184c0e47098a5b665e2a12****,78dc866518b843259669df58ed30****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DBList' => [ + 'description' => 'DNA库列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'DBInfo', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'DNA库状态。默认值：**offline**（离线）。**active**表示DNA库可用。可取值：'."\n" + .'- **offline**：离线。'."\n" + .'- **active**：在线。'."\n" + .'- **deleted**：删除。', + 'type' => 'string', + 'example' => 'active', + ], + 'Description' => [ + 'description' => 'DNA库描述。', + 'type' => 'string', + 'example' => '这是一个视频DNA库。', + ], + 'Name' => [ + 'description' => 'DNA库名称。', + 'type' => 'string', + 'example' => 'example-name', + ], + 'Model' => [ + 'description' => 'DNA库模型。包含：'."\n" + .'- **Video**：视频'."\n" + .'- **Audio**：音频'."\n" + .'- **Image**：图片'."\n" + .'- **Text**：文本【仅上海区域支持】', + 'type' => 'string', + 'example' => 'Video', + ], + 'DBId' => [ + 'description' => 'DNA库Id。', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DBList\\": [\\n {\\n \\"Status\\": \\"active\\",\\n \\"Description\\": \\"这是一个视频DNA库。\\",\\n \\"Name\\": \\"example-name\\",\\n \\"Model\\": \\"Video\\",\\n \\"DBId\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ],\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\"\\n}","type":"json"}]', + 'title' => '查询DNA库', + ], + 'SubmitDNAJob' => [ + 'summary' => '调用SubmitDNAJob提交DNA作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输入DNA文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => '1b1b9cd148034739af413150fded****', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '管道ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5246b8d12a62433ab77845074039****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA配置，JSON对象。'."\n" + .'若填写，会覆盖模板参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"SaveType": "save","MediaType":"video"}', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模版ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'S00000101-100060', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度128个字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'userData', + ], + ], + [ + 'name' => 'PrimaryKey', + 'in' => 'query', + 'schema' => [ + 'description' => '唯一的视频主键，唯一性由用户保证。', + 'type' => 'string', + 'required' => true, + 'example' => '3ca84a39a9024f19853b21be9cf9****', + ], + ], + [ + 'name' => 'DBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库ID。如需创建DNA库，请参见[CreateDNADB - 创建DNA库](~~479275~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => '视频DNA作业ID。建议您保存此ID便于后续调用其他相关接口时使用。', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"88c6ca184c0e47098a5b665e2****\\"\\n}","type":"json"}]', + 'title' => '提交DNA作业', + 'description' => '- 本接口为异步接口。不保证接口返回时结果已经生成。'."\n" + ."\n" + .'- 本接口目前支持使用的地域为华北2（北京）、华东1（杭州）、华东2（上海）。'."\n" + ."\n" + .'- 提交文本DNA作业目前仅支持华东2（上海）地域使用。', + 'requestParamsDescription' => 'DNA配置Config参数包括：SaveType和MediaType字段。'."\n" + ."\n" + .'其中，SaveType表示存储类型，包括：'."\n" + ."\n" + .'- **nosave**: 仅搜索不入库。'."\n" + .'- **save**: 去重入库。'."\n" + .'- **forcesave**: 强制入库。'."\n" + .'- **onlysave**: 仅入库不搜索。'."\n" + ."\n" + .'MediaType表示输入文件媒体类型，包括：'."\n" + .'- **video**: 视频。'."\n" + .'- **audio**: 音频。'."\n" + .'- **image**: 图片。'."\n" + .'- **text**: 长文本。'."\n" + .'- **asr**: asr识别文本。', + ], + 'CancelDNAJob' => [ + 'summary' => '调用CancelDNAJob取消DNA作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '取消DNA作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\"\\n}","type":"json"}]', + 'title' => '取消DNA作业', + 'description' => '- 本接口只能取消状态处于“排队中”状态的作业；'."\n" + ."\n" + .'- 建议先调用更新管道接口（**UpdatePipeline**）将管道状态置为Paused，暂停作业调度，再调用取消作业接口取消作业；取消完后需要恢复管道状态为Active，管道中的作业才会被调度执行。', + ], + 'DeleteDNAFiles' => [ + 'summary' => '调用DeleteDNAFiles删除DNA文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DBId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除文件的DNA库ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fb712a6890464059b1b2ea7c8647****', + ], + ], + [ + 'name' => 'PrimaryKeys', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的文件主键，用半角逗号（,）分隔，一次最多删除50个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '41e6536e4f2250e2e9bf26cdea19****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\"\\n}","type":"json"}]', + 'title' => '删除DNA文件', + ], + 'ListDNAFiles' => [ + 'summary' => '调用ListDNAFiles查询DNA文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询。请求第一页时，NextPageToken为空；请求后续文件时需传入前一页查询结果中的NextPageToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '单页数据个数，默认为20，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'DBId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNA库Id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2AE89FA5-E620-56C7-9B80-75D09757385A', + ], + 'NextPageToken' => [ + 'description' => '下一页Token。', + 'type' => 'string', + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + 'FileList' => [ + 'description' => '文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNAFile', + 'type' => 'object', + 'properties' => [ + 'PrimaryKey' => [ + 'description' => 'DNA文件用户主键。', + 'type' => 'string', + 'example' => 'ae0fd49c0840e14daf0d66a75b83****', + ], + 'InputFile' => [ + 'description' => '输入文件OSS信息。', + 'type' => 'object', + 'properties' => [ + 'Object' => [ + 'description' => '输入文件的OSS Object。', + 'type' => 'string', + 'example' => 'example-****.mp4', + ], + 'Location' => [ + 'description' => '输入文件的OSS Location。', + 'type' => 'string', + 'example' => 'oss-cn-beijing', + ], + 'Bucket' => [ + 'description' => '输入文件的OSS Bucket。', + 'type' => 'string', + 'example' => 'example-bucket', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AE89FA5-E620-56C7-9B80-75D09757385A\\",\\n \\"NextPageToken\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"FileList\\": [\\n {\\n \\"PrimaryKey\\": \\"ae0fd49c0840e14daf0d66a75b83****\\",\\n \\"InputFile\\": {\\n \\"Object\\": \\"example-****.mp4\\",\\n \\"Location\\": \\"oss-cn-beijing\\",\\n \\"Bucket\\": \\"example-bucket\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询DNA文件', + 'description' => '本接口通过DNA库ID查询文件列表，支持分页查询。', + ], + 'QueryDNAJobList' => [ + 'summary' => '调用QueryDNAJobList查询DNA作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的DNA作业ID列表。一次最多建议查询10个，用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'JobList' => [ + 'description' => 'DNA作业信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNAJob', + 'type' => 'object', + 'properties' => [ + 'DNAResult' => [ + 'description' => 'DNA结果链接。', + 'type' => 'string', + 'example' => 'http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt', + ], + 'PrimaryKey' => [ + 'description' => '唯一的视频主键，唯一性由用户保证。', + 'type' => 'string', + 'example' => '3ca84a39a9024f19853b21be9cf9****', + ], + 'DBId' => [ + 'description' => 'DNA库Id。', + 'type' => 'string', + 'example' => '2288c6ca184c0e47098a5b665e2a12****', + ], + 'CreationTime' => [ + 'description' => '作业创建时间。', + 'type' => 'string', + 'example' => '2022-12-28T03:21:37Z', + ], + 'FinishTime' => [ + 'description' => '作业完成时间。', + 'type' => 'string', + 'example' => '2022-12-28T03:21:44Z', + ], + 'Status' => [ + 'description' => '作业状态，可取值：'."\n" + ."\n" + .'- **Queuing**：排队中。'."\n" + .'- **Analysing**：分析中。'."\n" + .'- **Success**：成功。'."\n" + .'- **Fail**：失败。', + 'type' => 'string', + 'example' => 'Queuing', + ], + 'Message' => [ + 'description' => '作业执行错误信息。', + 'type' => 'string', + 'example' => '"The resource operated \\"a887d0b***d805ef6f7f6786302\\" cannot be found"', + ], + 'Config' => [ + 'description' => 'DNA配置。', + 'type' => 'string', + 'example' => '{"SaveType": "save","MediaType"":"video"}', + ], + 'UserData' => [ + 'description' => '用户自定义数据。', + 'type' => 'string', + 'example' => 'testdna', + ], + 'Code' => [ + 'description' => '作业执行错误码。', + 'type' => 'string', + 'example' => '"InvalidParameter.ResourceNotFound"', + ], + 'Input' => [ + 'description' => '输入文件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'Media', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'example' => '1b1b9cd148034739af413150fded****', + ], + ], + ], + 'Id' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '88c6ca184c0e47098a5b665e2a12****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"JobList\\": [\\n {\\n \\"DNAResult\\": \\"http://test_bucket.oss-cn-shanghai.aliyuncs.com/fingerprint/video/search_result/5/5.txt\\",\\n \\"PrimaryKey\\": \\"3ca84a39a9024f19853b21be9cf9****\\",\\n \\"DBId\\": \\"2288c6ca184c0e47098a5b665e2a12****\\",\\n \\"CreationTime\\": \\"2022-12-28T03:21:37Z\\",\\n \\"FinishTime\\": \\"2022-12-28T03:21:44Z\\",\\n \\"Status\\": \\"Queuing\\",\\n \\"Message\\": \\"\\\\\\"The resource operated \\\\\\\\\\\\\\"a887d0b***d805ef6f7f6786302\\\\\\\\\\\\\\" cannot be found\\\\\\"\\",\\n \\"Config\\": \\"{\\\\\\"SaveType\\\\\\": \\\\\\"save\\\\\\",\\\\\\"MediaType\\\\\\"\\\\\\":\\\\\\"video\\\\\\"}\\",\\n \\"UserData\\": \\"testdna\\",\\n \\"Code\\": \\"\\\\\\"InvalidParameter.ResourceNotFound\\\\\\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"Media\\",\\n \\"Media\\": \\"1b1b9cd148034739af413150fded****\\"\\n },\\n \\"Id\\": \\"88c6ca184c0e47098a5b665e2a12****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询DNA作业列表', + 'responseParamsDescription' => 'DNAResult的内容为Array of VideoMatchInfo，其中：'."\n" + ."\n" + .'**VideoMatchInfo详情**'."\n" + ."\n" + .'| 名称| 类型 |描述 | '."\n" + .'| ---------| --------- | ----------- | '."\n" + .'| PrimaryKey | String | 匹配文件唯一主键。 | '."\n" + .'| GlobalSimilarity | Double |整体相似度。 | '."\n" + .'| VideoMatchSegments | Array of VideoMatchSegment | 视频/图搜视频匹配片段信息。| '."\n" + .'| AudioMatchSegments| Array of AudioMatchSegment | 音频搜音频匹配片段信息。| '."\n" + .'| TextMatchSegments | Array of TextMatchSegment | 文本搜文本匹配片段信息。|'."\n" + ."\n" + .'**VideoMatchSegment/AudioMatchSegment详情**'."\n" + ."\n" + .'|名称 |类型 |描述|'."\n" + .'| ---------| --------- | ----------- | '."\n" + .'|StartTime |Double| 输入视频/音频的开始时间。|'."\n" + .'|EndTime|Double |输入视频/音频的结束时间。|'."\n" + .'|MasterStartTime| Double |库中视频/音频的开始时间。|'."\n" + .'|MasterEndTime| Double |库中视频/音频的结束时间。|'."\n" + .'|Similarity| Double |匹配片段的置信度。|'."\n" + ."\n" + .'**TextMatchSegment详情**'."\n" + .'|名称 |类型 |描述|'."\n" + .'| ---------| --------- | ----------- | '."\n" + .'Start |Double |查询匹配片段起始时间。'."\n" + .'End| Double| 查询匹配片段结束时间。'."\n" + .'QueryText| String |查询匹配的文本片段。'."\n" + .'MasterText| String| 底库匹配的文本片段。'."\n" + .'Similarity |Double |匹配片段的置信度。', + ], + 'SubmitCopyrightJob' => [ + 'summary' => '调用SubmitCopyrightJob提交视频版权水印任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待添加水印的视频文件。'."\n" + ."\n" + .'> - OSS文件/媒资的地域需要与当前IMS所在地域保持一致。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '输出文件地址。'."\n" + ."\n" + .'> - OSS的地域需要与当前IMS所在地域保持一致。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出文件类型，取值：'."\n" + ."\n" + .'1. OSS：OSS文件地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出文件信息，支持 OSS 地址。 OSS 地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + .'其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-bucket/output.mp4', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '水印信息', + 'description' => '待添加的水印信息。', + 'type' => 'string', + 'required' => true, + 'example' => '版权水印测试', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '水印起始时间，单位为秒，不填写默认为0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '水印结束时间，单位为秒，不填写默认为视频时长。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '水印级别，取值0/1/2，表示嵌入通道，0u，1uv，2yuv。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '水印信息描述。', + 'type' => 'string', + 'required' => false, + 'example' => '任务描述', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '水印任务参数，JSONString。目前支持设置参数如下：'."\n" + ."\n" + .'- algoType：算法类型，默认值为v1。'."\n" + .' - v1：长视频版权水印，仅支持3min以上的。'."\n" + .' - v2：短视频版权水印。', + 'type' => 'string', + 'required' => false, + 'example' => '{"algoType":"v2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'bfb786c63****f4d80648792021eff90', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'FA258E67-09B8-4EAA-8F33-BA567834A2C3'."\n", + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c63****f4d80648792021eff90\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"FA258E67-09B8-4EAA-8F33-BA567834A2C3\\\\n\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '提交视频版权水印作业', + 'description' => '- 提交视频版权水印作业默认仅支持3分钟及以上视频，视频时间过短会导致接口调用失败或无输出。如果需要对3分钟以内的短视频添加版权水印，可以通过Params参数指定，详见参数描述。'."\n" + ."\n" + .'- 提交视频版权水印作业每次接口的调用，都是对独立视频进行添加水印，不支持多个视频同时提交。'."\n" + ."\n" + .'- 目前数字水印相关接口只支持华东2（上海）、华北 2（北京）地域使用。', + ], + 'QueryCopyrightJobList' => [ + 'summary' => '查询视频版权水印任务列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '起始创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357322', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '截止创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357325', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务Id。', + 'type' => 'string', + 'required' => false, + 'example' => '****cdb3e74639973036bc84****', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '水印级别，取值0/1/2，表示嵌入通道，0u，1uv，2yuv。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页下标。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '响应数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'Input' => [ + 'description' => '水印视频输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '水印视频输入。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'Output' => [ + 'description' => '水印视频输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出文件类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出文件信息。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021****', + ], + 'Level' => [ + 'title' => '水印强度', + 'description' => '水印强度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Message' => [ + 'title' => '水印信息', + 'description' => '水印信息', + 'type' => 'string', + 'example' => 'test', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '任务结果', + 'type' => 'string', + 'example' => '{"Code":"success","Message":"ok"}', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'success', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '123', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1346693***'."\n", + ], + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******36-3C1E-4417-BDB2-1E034F******', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"JobId\\": \\"bfb786c639894f4d80648792021****\\",\\n \\"Level\\": 2,\\n \\"Message\\": \\"test\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询视频版权水印作业列表', + 'description' => '- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。', + ], + 'SubmitCopyrightExtractJob' => [ + 'summary' => '提交版权水印提取作业。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待提取水印的视频文件。'."\n" + ."\n" + .'> - OSS文件/媒资的地域需要与当前IMS所在地域保持一致。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '水印任务参数，JSONString。目前支持设置参数如下：'."\n" + ."\n" + .'- algoType：算法类型，默认值为v1。提取算法类型需和嵌入时使用的算法类型一致。'."\n" + ."\n" + .' - v1：长视频版权提取接口。'."\n" + .' - v2：短视频版权提取接口。', + 'type' => 'string', + 'required' => false, + 'example' => '{"algoType":"v2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'bfb786c63****4d80648792021eff90', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****2876-6263-4B75-8F2C-CD0F7FCF****', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c63****4d80648792021eff90\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"****2876-6263-4B75-8F2C-CD0F7FCF****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '提交版权水印提取作业', + 'description' => '- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。', + ], + 'QueryCopyrightExtractJob' => [ + 'summary' => '查询版权水印提取任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务Id。可以通过提交版权水印提取作业的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => '2288c6ca184c0e47098a5b665e2a12****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '版权水印信息', + 'description' => '版权水印信息', + 'type' => 'string', + 'example' => '版权水印测试', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Message\\": \\"版权水印测试\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询版权水印提取作业', + ], + 'SubmitTraceAbJob' => [ + 'summary' => '提交视频溯源水印ab流任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '溯源水印ab流处理视频输入视频文件。'."\n" + ."\n" + .'> - OSS文件/媒资的地域需要与当前IMS所在地域保持一致。'."\n" + .'> - 提交视频溯源水印ab流作业目前仅支持3分钟及以上视频，视频时间过短会导致接口调用失败或无输出。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入文件类型，取值：'."\n" + .'1. OSS：OSS文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '溯源水印ab流处理输出OSS地址。需要注意的是，配置的是输出目录Dir。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出路径信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1、oss://bucket/dir/'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/dir/'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，dir为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/dir/', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '水印嵌入开始时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TotalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '水印嵌入总时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '360', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '水印级别，取值0/1/2，表示嵌入通道，0u，1uv，2yuv。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度1024个字节。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'CipherBase64ed', + 'in' => 'query', + 'schema' => [ + 'description' => 'base64后的加密密钥。', + 'type' => 'string', + 'required' => false, + 'example' => 'Qh6OdgIMcliQSI1fReOw****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务Id', + 'description' => '任务Id', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + 'TraceMediaId' => [ + 'title' => '媒体Id', + 'description' => '媒体Id', + 'type' => 'string', + 'example' => 'bf53333264f4d80648792021e****', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******36-3C1E-4417-BDB2-1E034F******', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\",\\n \\"TraceMediaId\\": \\"bf53333264f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******36-3C1E-4417-BDB2-1E034F******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '提交视频溯源水印ab流作业', + 'description' => '- 提交视频溯源水印ab流作业目前仅支持3分钟及以上视频，视频时间过短会导致接口调用失败或无输出。', + ], + 'QueryTraceAbJobList' => [ + 'summary' => '查询视频溯源水印ab流任务列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。可以从提交视频溯源水印ab流的返回参数中获取。', + 'type' => 'string', + 'required' => false, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + [ + 'name' => 'TraceMediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '溯源水印媒体Id，可以从提交视频溯源水印ab流的返回参数中获取。', + 'type' => 'string', + 'required' => false, + 'example' => '****437bd2b51105d07b12a9****', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '起始创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357322', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '截止创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357325', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页下标。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '响应数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'Input' => [ + 'description' => '水印视频输入', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'Output' => [ + 'description' => 'AB流输出路径。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出类型，取值：'."\n" + .'1. OSS：oss文件地址'."\n" + .'2. Media：媒资ID', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出路径信息。', + 'type' => 'string', + 'example' => 'oss://bucket/dir/', + ], + ], + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021eff90', + ], + 'Level' => [ + 'title' => '水印强度', + 'description' => '水印强度', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TraceMediaId' => [ + 'title' => '媒体id', + 'description' => '溯源水印媒体Id。', + 'type' => 'string', + 'example' => '****437bd2b51105d07b12a9****', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '任务结果', + 'type' => 'string', + 'example' => '{"Code":"success","Message":"ok"}', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'success', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '123', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13466932****', + ], + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/dir/\\"\\n },\\n \\"JobId\\": \\"bfb786c639894f4d80648792021eff90\\",\\n \\"Level\\": 2,\\n \\"TraceMediaId\\": \\"****437bd2b51105d07b12a9****\\",\\n \\"Result\\": \\"{\\\\\\"Code\\\\\\":\\\\\\"success\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"ok\\\\\\"}\\",\\n \\"Status\\": \\"success\\",\\n \\"UserData\\": \\"123\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询视频溯源水印ab流作业列表', + 'description' => '- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。', + ], + 'SubmitTraceM3u8Job' => [ + 'summary' => '提交视频溯源水印m3u8文件任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'TraceMediaId', + 'in' => 'query', + 'schema' => [ + 'description' => '溯源水印ab流处理后的媒体Id，可以从提交视频溯源水印ab流的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '437bd2b516ffda105d07b12a9a82****', + ], + ], + [ + 'name' => 'Output', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'm3u8文件输出OSS地址。'."\n" + ."\n\n" + .'> OSS的地域需要与当前MPS所在地域保持一致。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输出文件类型，取值：'."\n" + ."\n" + .'1. OSS：OSS文件地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出文件信息，支持 OSS 地址。 OSS 地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + .'其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Trace', + 'in' => 'query', + 'schema' => [ + 'description' => '溯源水印信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '溯源水印测试', + ], + ], + [ + 'name' => 'KeyUri', + 'in' => 'query', + 'schema' => [ + 'description' => '密钥服务器uri。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cipher.abc.com', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '水印任务参数，JSONString。目前支持设置参数如下：'."\n" + ."\n" + .'- m3u8Type：算法类型，默认值为v1。'."\n" + ."\n" + .' - v1：生成绝对路径的m3u8，可直接播放。签名鉴权有效期为24小时，过期后需重新提交任务获取m3u8。'."\n" + ."\n" + .' - v2：生成相对路径的m3u8，需要和ts文件放在相同路径下。', + 'type' => 'string', + 'required' => false, + 'example' => '{"m3u8Type":"v1"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id。', + 'type' => 'string', + 'example' => 'bfb786c639894f4d8064879202****', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d8064879202****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '提交视频溯源水印m3u8作业', + 'description' => '- 使用本接口前需先调用提交视频溯源水印ab流，获取到ab流处理后的媒体ID，再调用本接口进行处理。'."\n" + ."\n" + .'- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。'."\n" + ."\n" + .'- 经过视频溯源水印m3u8作业处理生成的m3u8文件签名鉴权有效期为24小时（从处理完成开始计时），请尽快查询，签名鉴权过期后将无法查询到该次作业的水印信息。如签名鉴权过期后需要，请重新提交视频溯源水印m3u8作业。', + ], + 'QueryTraceM3u8JobList' => [ + 'summary' => '查询视频溯源水印m3u8任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '起始创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357322', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '截止创建时间，时间戳形式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1627357325', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。可以从提交视频溯源水印m3u8的返回参数中获取。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页下标。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627357322', + ], + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => '****d718e2ff4f018ccf419a7b71****', + ], + 'TraceMediaId' => [ + 'description' => '溯源媒体ID。', + 'type' => 'string', + 'example' => '****437bd2b105d07b12a9a82****', + ], + 'Output' => [ + 'description' => '水印视频输出', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '媒体对象类型。'."\n" + .'取值： '."\n" + .'- OSS: OSS文件。'."\n" + .'- Media: 媒资 ID。'."\n", + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输出文件信息。', + 'type' => 'string', + 'example' => 'oss://bucket/object', + ], + ], + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'success', + ], + 'Trace' => [ + 'title' => '水印信息', + 'description' => '水印信息', + 'type' => 'string', + 'example' => 'test', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '112', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1346693276****', + ], + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 1627357322,\\n \\"GmtModified\\": 1627357322,\\n \\"JobId\\": \\"****d718e2ff4f018ccf419a7b71****\\",\\n \\"TraceMediaId\\": \\"****437bd2b105d07b12a9a82****\\",\\n \\"Output\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"oss://bucket/object\\"\\n },\\n \\"Status\\": \\"success\\",\\n \\"Trace\\": \\"test\\",\\n \\"UserData\\": \\"112\\",\\n \\"UserId\\": 0\\n }\\n ],\\n \\"Message\\": \\"ok\\",\\n \\"StatusCode\\": 200,\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '查询视频溯源水印m3u8作业列表', + 'description' => '- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。'."\n" + ."\n" + .'- 经过视频溯源水印m3u8作业处理生成的绝对路径的m3u8文件签名鉴权有效期为24小时（从处理完成开始计时），请尽快查询，签名鉴权过期后将无法访问该次作业的生成的m3u8。如签名鉴权过期后需要，请重新提交视频溯源水印m3u8作业。', + ], + 'SubmitTraceExtractJob' => [ + 'summary' => '提交溯源水印提取任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待提取水印的视频文件。'."\n" + ."\n\n" + .'> - OSS文件/媒资的地域需要与当前IMS所在地域保持一致。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，取值：'."\n" + ."\n" + .'- OSS：OSS文件地址。'."\n" + ."\n" + .'- Media：媒资ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入文件信息，支持OSS地址和媒资ID两种。'."\n" + .'OSS地址规则为：'."\n" + ."\n" + .'1、oss://bucket/object'."\n" + ."\n" + .'2、http(s)://bucket.oss-[regionId].aliyuncs.com/object'."\n" + ."\n" + .'其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://bucket/object', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义数据，最大长度1024字节。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '提取任务参数，JSONString。目前支持设置参数如下：'."\n" + ."\n" + .'- m3u8Type：算法类型，默认值为v1。'."\n" + ."\n" + .' - v1：提取绝对路径的m3u8。'."\n" + .' - v2：提取相对路径的m3u8。', + 'type' => 'string', + 'required' => false, + 'example' => '{"m3u8Type":"v1"}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'bfb786c639894f4d80648792021e****', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"JobId\\": \\"bfb786c639894f4d80648792021e****\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '提交溯源水印提取作业', + 'description' => '- 目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。'."\n" + ."\n" + .'- 溯源水印提取仅支持3min以上的视频，小于则任务会失败。', + ], + 'QueryTraceExtractJob' => [ + 'summary' => '查询溯源水印提取任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。可以从提交溯源水印提取作业的返回参数中获取。', + 'type' => 'string', + 'required' => true, + 'example' => '31fa3c9ca8134fb4b0b0f7878301****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Trace' => [ + 'title' => '溯源水印信息', + 'description' => '溯源水印信息', + 'type' => 'string', + 'example' => '测试溯源水印', + ], + ], + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'StatusCode' => [ + 'title' => '状态码', + 'description' => '状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Trace\\": \\"测试溯源水印\\"\\n },\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"StatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询溯源水印提取作业', + 'description' => '目前数字水印相关接口只支持华东2（上海）、华北2（北京）地域使用。', + ], + 'DescribeMeterImsMediaConvertUHDUsage' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146742', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1654403036', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656995036', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '目前该字段暂未生效，默认返回全部region用量。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间粒度，枚举值：3600（小时粒度），86400（天粒度）。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '3600'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', + ], + 'Data' => [ + 'description' => 'IMS的MPS转码UHD计量数据。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '时间段开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656950400', + ], + 'Specification' => [ + 'description' => '转码规格。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'SuperResolution.Standard.1080P'."\n", + ], + 'Duration' => [ + 'description' => '时长，单位min。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '308028', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Specification\\": \\"SuperResolution.Standard.1080P\\\\n\\",\\n \\"Duration\\": 308028\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IMS的MPS转码UHD计量查询', + 'summary' => 'IMS的MPS转码UHD计量查询，最大查询范围31天，最远可查90天内的数据。', + ], + 'DescribeMeterImsMediaConvertUsage' => [ + 'summary' => 'IMS的点播转码计量查询，最大查询范围31天，最远可查90天内的数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146741', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，10位。最远可查90天内的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1654403036', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，10位。最大查询间隔为31天，即与StartTs的间隔时间不超过31天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656995036', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '目前该字段暂未生效，默认返回全部region用量。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai'."\n", + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间粒度，枚举值：3600（小时粒度），86400（天粒度）。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '86400', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FBBB5210-2B78-58FB-A6FE-9DD887BB2C61', + ], + 'Data' => [ + 'description' => 'IMS的点播转码计量数据。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '时间段开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656950400', + ], + 'Specification' => [ + 'description' => '转码规格。', + 'type' => 'string', + 'example' => 'H264.HD'."\n", + ], + 'Duration' => [ + 'description' => '时长，单位min。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBB5210-2B78-58FB-A6FE-9DD887BB2C61\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Specification\\": \\"H264.HD\\\\n\\",\\n \\"Duration\\": 20\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IMS的点播转码计量查询', + ], + 'DescribeMeterImsEditUsage' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146735', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1654403036', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656995036', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询时间粒度，枚举值：3600（小时粒度），86400（天粒度）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '86400', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '目前该字段暂未生效，默认返回全部region用量。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7F3AE2C6-5CC6-5712-BAC5-5A735A157687', + ], + 'Data' => [ + 'description' => 'IMS点播视频剪辑用量数据。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '时间段开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656950400', + ], + 'Duration' => [ + 'description' => '时长，单位min。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1.23', + ], + 'Profile' => [ + 'description' => '规格。', + 'type' => 'string', + 'example' => '1080P', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F3AE2C6-5CC6-5712-BAC5-5A735A157687\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Duration\\": 1.23,\\n \\"Profile\\": \\"1080P\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IMS点播视频剪辑用量查询', + 'summary' => 'IMS点播视频剪辑用量查询，最大查询范围31天，最远可查90天内的数据。', + ], + 'DescribeMeterImsSummary' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146724', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1654403036', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，10位。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656995036', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '目前该字段暂未生效，默认返回全部region用量。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BEA98A0C-7870-15FE-B96F-8880BB600A2C', + ], + 'Data' => [ + 'description' => 'IMS点播用量统计数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MpsTranscodeDuration' => [ + 'description' => '点播转码时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17337', + ], + 'MpsTranscodeUHDDuration' => [ + 'description' => '音画增强时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'LiveTranscodeDuration' => [ + 'description' => '直播转码时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12356', + ], + 'EditingDuration' => [ + 'description' => '视频剪辑时长。', + 'type' => 'string', + 'example' => '8722', + ], + 'MpsAiDuration' => [ + 'description' => '视频AI时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LiveRecordDuration' => [ + 'description' => '直播录制时长', + 'type' => 'string', + 'example' => '100', + ], + 'LiveEditDuration' => [ + 'description' => '直播剪辑时长', + 'type' => 'string', + 'example' => '2000', + ], + 'LiveSnapshotCount' => [ + 'description' => '直播截图数量', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA98A0C-7870-15FE-B96F-8880BB600A2C\\",\\n \\"Data\\": [\\n {\\n \\"MpsTranscodeDuration\\": 17337,\\n \\"MpsTranscodeUHDDuration\\": 300,\\n \\"LiveTranscodeDuration\\": 12356,\\n \\"EditingDuration\\": \\"8722\\",\\n \\"MpsAiDuration\\": 0,\\n \\"LiveRecordDuration\\": \\"100\\",\\n \\"LiveEditDuration\\": \\"2000\\",\\n \\"LiveSnapshotCount\\": \\"100\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IMS点播用量统计查询', + 'summary' => 'IMS点播用量统计查询，最大查询范围31天，最远可查90天内的数据。', + ], + 'DescribeMeterImsMpsAiUsage' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146716', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，10位。最远可查90天内的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1654403036', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳，10位。。最大查询间隔为31天，即与StartTs的间隔时间不超过31天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656995036', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '枚举值：3600（小时粒度），86400（天粒度）。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '86400', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '目前该字段暂未生效，默认返回全部region用量。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', + ], + 'Data' => [ + 'description' => 'IMS的MPS-AI计量数据。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '时间段开始时间戳，10位。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656950400', + ], + 'Type' => [ + 'description' => 'AI类型。', + 'type' => 'string', + 'example' => 'Censor：审核类型'."\n" + .'Product：生产类型', + ], + 'Duration' => [ + 'description' => '时长，单位min。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '644', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"Data\\": [\\n {\\n \\"Time\\": 1656950400,\\n \\"Type\\": \\"Censor：审核类型\\\\nProduct：生产类型\\",\\n \\"Duration\\": 644\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IMS的MPS-AI计量查询', + 'summary' => 'IMS的MPS-AI用量查询，最大查询范围31天，最远可查90天内的数据。', + ], + 'SetEventCallback' => [ + 'summary' => '设置特定事件的通知机制。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'CallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => '回调方式，取值：'."\n" + .'- **HTTP**'."\n" + .'- **MNS**', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MNS' => 'MNS', + 'HTTP' => 'HTTP', + ], + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'CallbackQueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '所在区域的MNS队列名称，必须以 ice-callback- 开头', + 'type' => 'string', + 'required' => false, + 'example' => 'ice-callback-queue', + ], + ], + [ + 'name' => 'CallbackURL', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。回调方式为**HTTP**时，需设置此参数。'."\n" + .'回调地址URL的长度不能超过256个字节，不支持设置多个回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxx.yyy/callback', + ], + ], + [ + 'name' => 'EventTypeList', + 'in' => 'query', + 'schema' => [ + 'description' => '回调事件类型, 支持多值，以逗号分隔。'."\n" + .'ProduceMediaComplete：剪辑合成作业完成', + 'type' => 'string', + 'required' => false, + 'example' => 'ProduceMediaComplete', + ], + ], + [ + 'name' => 'AuthSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP回调的鉴权开关，回调方式设置为**HTTP**时，此参数有效。取值：'."\n" + .'- **on**（启用）'."\n" + .'- **off**（不启用）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + ], + [ + 'name' => 'AuthKey', + 'in' => 'query', + 'schema' => [ + 'description' => '鉴权Key，最长32位，必须同时包含大小写字母和数字。回调方式为**HTTP**时，可设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Success' => [ + 'title' => '是否设置成功', + 'description' => '是否设置成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetEventCallbackResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <Success>true</Success>\\n</SetEventCallbackResponse>","errorExample":""}]', + 'title' => '设置事件回调', + ], + 'GetEventCallback' => [ + 'summary' => '调用GetEventCallback获取事件回调配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'CallbackType' => [ + 'description' => '回调方式，取值：'."\n" + .'- **HTTP**'."\n" + .'- **MNS**'."\n" + ."\n" + .'回调方式说明，详情请参见[回调方式说明](~~610204~~)。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MNS' => 'MNS', + 'HTTP' => 'HTTP', + ], + 'example' => 'HTTP', + ], + 'CallbackQueueName' => [ + 'description' => '回调MNS队列名称。', + 'type' => 'string', + 'example' => 'ice-callback-queue', + ], + 'CallbackURL' => [ + 'description' => '事件通知回调地址。', + 'type' => 'string', + 'example' => 'http://xxx.yyy/callback', + ], + 'EventTypeList' => [ + 'description' => '回调事件类型，多值以逗号分隔。事件类型参考 [事件通知内容](~~610174~~) 。', + 'type' => 'string', + 'example' => 'ProduceMediaComplete,TranscodeComplete', + ], + 'AuthSwitch' => [ + 'description' => 'HTTP回调的鉴权开关，回调方式设置为**HTTP**时，此参数有效。取值：'."\n" + .'- **on**（启用）'."\n" + .'- **off**（不启用）', + 'type' => 'string', + 'enumValueTitles' => [ + 'off' => 'off', + 'on' => 'on', + ], + 'example' => 'on', + ], + 'AuthKey' => [ + 'description' => '回调方式选择HTTP时，鉴权Key。', + 'type' => 'string', + 'example' => 'TestKey001', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"CallbackType\\": \\"HTTP\\",\\n \\"CallbackQueueName\\": \\"ice-callback-queue\\",\\n \\"CallbackURL\\": \\"http://xxx.yyy/callback\\",\\n \\"EventTypeList\\": \\"ProduceMediaComplete,TranscodeComplete\\",\\n \\"AuthSwitch\\": \\"on\\",\\n \\"AuthKey\\": \\"TestKey001\\"\\n}","errorExample":""},{"type":"xml","example":"<GetEventCallbackResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <CallbackQueueName>ice-callback-queue</CallbackQueueName>\\n <EventTypeList>ProduceMediaComplete</EventTypeList>\\n</GetEventCallbackResponse>","errorExample":""}]', + 'title' => '获取事件回调', + ], + 'StartWorkflow' => [ + 'summary' => '通过调用StartWorkflow接口，您可以提交工作流模板任务，从而实现基于工作流模板的自动化媒体处理流程。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '工作流模板ID。您可通过[智能媒体服务控制台](https://ims.console.aliyun.com/settings/workflow/list)> 配置管理 > 工作流模板，查看模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '******f0e54971ecbffd472190******', + ], + ], + [ + 'name' => 'TaskInput', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '工作流输入，目前支持媒资类型和OSS文件。'."\n" + ."\n" + .'Type，支持的媒体对象类型，取值：'."\n" + ."\n" + .'- OSS：oss文件'."\n" + ."\n" + .'- Media：媒资ID'."\n" + ."\n" + .'Media，媒体值，取值：'."\n" + ."\n" + .'- type为 OSS 时，为 URL, 支持 OSS 协议和 HTTP 协议。'."\n" + ."\n" + .'- type 为 Media 时，为媒资 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "Type": "Media",'."\n" + .' "Media": "******30706071edbfe290b488******"'."\n" + .'}或'."\n" + .'{'."\n" + .' "Type": "OSS",'."\n" + .' "Media": "oss://bucket/path/to/video.mp4"'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义设置，Json格式，长度限制为512字节。支持[自定义回调地址配置](~~451631~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'SkipInputVerification', + 'in' => 'query', + 'schema' => [ + 'description' => '是否跳过工作流支持输入路径的检查，仅当工作流输入为OSS文件时有效。此处建议您选择不跳过，避免因路径出错而导致的错误。若缺省，则默认为不跳过检查。取值：'."\n" + ."\n" + .'- **true**：跳过'."\n" + ."\n" + .'- **false**：不跳过', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******42-E8E1-4FBB-8E52-F4225C******', + ], + 'TaskId' => [ + 'description' => '工作流任务ID。', + 'type' => 'string', + 'example' => '******22dad741d086a50325f9******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******42-E8E1-4FBB-8E52-F4225C******\\",\\n \\"TaskId\\": \\"******22dad741d086a50325f9******\\"\\n}","type":"json"}]', + 'title' => '提交工作流任务', + 'description' => '- 目前只支持智能媒体服务媒资/视频点播媒资作为工作流输入。'."\n" + .'- 发起工作流任务时，需指定工作流模板，可通过[智能媒体服务控制台](https://ims.console.aliyun.com/settings/workflow/list)创建工作流模板，或使用系统预置的工作流模板。', + 'requestParamsDescription' => '**工作流触发匹配规则**'."\n" + ."\n" + .'OSS文件触发工作流时规则匹配执行策略如下：以新增文件的路径为基础，检查工作流绑定的位置，如果新增文件的路径中包含规则绑定的字符串则匹配，不包含则不匹配。例如：http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test1.flv规则：'."\n" + ."\n" + .'```'."\n" + .'1、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/ 匹配'."\n" + .'2、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/ 匹配'."\n" + .'3、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/ 匹配'."\n" + .'4、http://bucket.oss-cn-hangzhou.aliyuncs.com/ 匹配'."\n" + .'5、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/C/test.flv 匹配'."\n" + .'6、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B/CC/ 不匹配'."\n" + .'7、http://bucket.oss-cn-hangzhou.aliyuncs.com/A/B2/ 不匹配'."\n" + .'8、http://bucket.oss-cn-hangzhou.aliyuncs.com/A2/B/C/ 不匹配'."\n" + .'```'."\n" + ."\n" + .'> 在新增媒体工作流时，请您不要配置一个工作流的输入路径为另外一个工作流的输入路径的前缀，否则会一个增量文件触发两次工作流执行实例。例如：两个工作流的输入路径分别配置 test 和 test1，则当输入文件上传到 test1 文件夹下同样满足 test 前缀，因此会触发两次工作流执行实例。'."\n" + ."\n\n" + .'**匹配文件扩展名**'."\n" + ."\n" + .'触发要求必须是多媒体文件，媒体库服务是通过文件扩展名来判断的。文件或者没有扩展名（文件名中不包含扩展名分割符号“.”），或者扩展名符合下面的规则：'."\n" + ."\n" + .'>对于 swf，截图及转码服务质量不保障。'."\n" + ."\n" + .'| 类型 | 扩展名 |'."\n" + .'|-------|-------'."\n" + .'| 视频 | 3gp, asf, avi, dat, dv, flv, f4v, gif, m2t, m3u8, m4v, mj2, mjpeg, mkv, mov, mp4, mpe, mpg, mpeg, mts, ogg, qt, rm, rmvb, swf, ts, vob, wmv, webm |'."\n" + .'| 音频 | aac, ac3, acm, amr, ape, caf, flac, m4a, mp3, ra, wav, wma, aiff |', + ], + 'GetWorkflowTask' => [ + 'summary' => '根据任务ID查询工作流任务，包括工作流Id、工作流任务状态、工作流任务结果。'."\n" + .'本接口仅支持查询近一年的工作流任务数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流任务Id', + 'type' => 'string', + 'required' => false, + 'example' => '******4215e042b3966ca5441e******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******0C-7870-15FE-B96F-8880BB******', + ], + 'WorkflowTask' => [ + 'description' => '工作流任务信息', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '工作流任务ID', + 'type' => 'string', + 'example' => '******4215e042b3966ca5441e******', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Init' => '任务初始化', + 'Failed' => '失败', + 'Canceled' => '任务已取消', + 'Processing' => '任务执行中', + 'Succeed' => '成功', + ], + 'example' => 'Succeed', + ], + 'TaskInput' => [ + 'description' => '工作流任务输入', + 'type' => 'string', + 'example' => '{'."\n" + .' "Type": "Media",'."\n" + .' "Media": "******30706071edbfe290b488******"'."\n" + .'}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2023-01-04T02:05:17Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2023-01-04T02:06:19Z', + ], + 'Workflow' => [ + 'description' => '工作流信息', + 'type' => 'object', + 'properties' => [ + 'WorkflowId' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'example' => '******63dca94c609de02ac0d1******', + ], + 'Name' => [ + 'description' => '工作流名称', + 'type' => 'string', + 'example' => '超分转码工作流', + ], + 'Status' => [ + 'description' => '工作流状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Active' => '启用', + 'Inactive' => '禁用', + ], + 'example' => 'Active', + ], + 'Type' => [ + 'description' => '工作流类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Customize' => '定制工作流', + 'System' => '系统工作流', + 'Common' => '用户创建工作流', + ], + 'example' => 'Common', + ], + 'CreateTime' => [ + 'description' => '工作流创建时间', + 'type' => 'string', + 'example' => '2022-11-27T10:02:12Z', + ], + 'ModifiedTime' => [ + 'description' => '工作流最后修改时间', + 'type' => 'string', + 'example' => '2022-11-29T02:06:19Z'."\n", + ], + ], + ], + 'ActivityResults' => [ + 'description' => '工作流任务各节点结果。', + 'type' => 'string', + 'example' => 'Json格式，内容根据工作流配置有变化。', + ], + 'UserData' => [ + 'description' => '用户提交工作流任务时设置的自定义字段。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******0C-7870-15FE-B96F-8880BB******\\",\\n \\"WorkflowTask\\": {\\n \\"TaskId\\": \\"******4215e042b3966ca5441e******\\",\\n \\"Status\\": \\"Succeed\\",\\n \\"TaskInput\\": \\"{\\\\n \\\\\\"Type\\\\\\": \\\\\\"Media\\\\\\",\\\\n \\\\\\"Media\\\\\\": \\\\\\"******30706071edbfe290b488******\\\\\\"\\\\n}\\",\\n \\"CreateTime\\": \\"2023-01-04T02:05:17Z\\",\\n \\"FinishTime\\": \\"2023-01-04T02:06:19Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"******63dca94c609de02ac0d1******\\",\\n \\"Name\\": \\"超分转码工作流\\",\\n \\"Status\\": \\"Active\\",\\n \\"Type\\": \\"Common\\",\\n \\"CreateTime\\": \\"2022-11-27T10:02:12Z\\",\\n \\"ModifiedTime\\": \\"2022-11-29T02:06:19Z\\\\n\\"\\n },\\n \\"ActivityResults\\": \\"Json格式，内容根据工作流配置有变化。\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => '查询工作流任务', + ], + 'ListWorkflowTasks' => [ + 'summary' => '遍历工作流任务实例。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流模板ID。您可通过[智能媒体服务控制台](https://ims.console.aliyun.com/settings/workflow/list)> 配置管理 > 工作流模板，查看模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '******b4fb044839815d4f2cd8******', + ], + ], + [ + 'name' => 'WorkflowName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'example-workflow-****', + ], + ], + [ + 'name' => 'KeyText', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名或者媒资id等，支持对TaskInput进行模糊查询，最大长度32。', + 'type' => 'string', + 'required' => false, + 'example' => '******7aa4cc4459ada8ef35f7******'."\n" + .'或'."\n" + .'**TestVideo***.flv', + ], + ], + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务创建时间筛选条件的开始时间，只支持近90天的时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-07-12T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置，置空表示从头开始', + 'description' => '任务创建时间筛选条件的结束时间，只支持近90天的时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-07-15T00:00:00Z', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大可返回的媒体工作流任务实例数。取值范围：[1,100]，默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '连续分页查询时下一页的标记 （第一页没有）。', + 'type' => 'string', + 'required' => false, + 'example' => '**************VRpbWUQARgBIpcBCgkA1bUtaAAAAAAKiQEDhAAAADFTMzg2NTY2NjU2MzM3NjU2NjYyMzkzMTYyMzI2MjYzNjY2**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '下一页标识', + 'type' => 'string', + 'required' => true, + 'example' => '****8EqYpQbZ6Eh7+Zz8DxVYoQ==', + ], + 'TaskList' => [ + 'description' => '媒体工作流任务列表', + 'type' => 'array', + 'items' => [ + 'description' => 'MediaServiceWorkflowTask - 工作流任务详细信息', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '工作流任务Id', + 'type' => 'string', + 'example' => '*****4c93d2f404f8345b16a965*****', + ], + 'TaskInput' => [ + 'description' => '工作流任务输入', + 'type' => 'string', + 'example' => '{\\"Type\\":\\"Media\\",\\"Media\\":\\"****8b40884171efb0d9e7f7f458****\\"}', + ], + 'Status' => [ + 'description' => '任务状态。'."\n" + ."\n" + .'**枚举值**'."\n" + .' - Init：任务初始化。'."\n" + .' - Failed：失败。'."\n" + .' - Canceled：任务已取消。'."\n" + .' - Processing：任务执行中。'."\n" + .' - Succeed：成功。', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2024-07-15T09:45:48Z', + ], + 'FinishTime' => [ + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2024-12-07T10:53:45Z', + ], + 'Workflow' => [ + 'description' => '工作流模板信息', + 'type' => 'object', + 'properties' => [ + 'WorkflowId' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'example' => '******2491c84dce913da9fe65******', + ], + 'Name' => [ + 'description' => '工作流模板名称', + 'type' => 'string', + 'example' => 'example-workflow-***', + ], + 'Status' => [ + 'description' => '工作流模板状态。', + 'type' => 'string', + 'example' => 'Active', + ], + 'Type' => [ + 'description' => '工作流模板类型。', + 'type' => 'string', + 'example' => 'Common', + ], + 'CreateTime' => [ + 'description' => '工作流模板创建时间。', + 'type' => 'string', + 'example' => '2025-03-21T01:48:49Z', + ], + 'ModifiedTime' => [ + 'description' => '工作流模板最后修改时间', + 'type' => 'string', + 'example' => '2025-02-23 10:19:37 +0800', + ], + 'MediaType' => [ + 'description' => '媒体来源。'."\n" + .' - OSS：oss文件'."\n" + .' - Media：媒资', + 'type' => 'string', + 'example' => 'OSS', + ], + ], + ], + 'UserData' => [ + 'description' => '用户提交工作流任务时设置的自定义字段。', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '本次请求所返回的最大任务条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 4,\\n \\"RequestId\\": \\"C0C02296-113C-5838-8FE9-8F3A32998DDC\\",\\n \\"NextToken\\": \\"****8EqYpQbZ6Eh7+Zz8DxVYoQ==\\",\\n \\"TaskList\\": [\\n {\\n \\"TaskId\\": \\"*****4c93d2f404f8345b16a965*****\\",\\n \\"TaskInput\\": \\"{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Media\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"****8b40884171efb0d9e7f7f458****\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Succeed\\",\\n \\"CreateTime\\": \\"2024-07-15T09:45:48Z\\",\\n \\"FinishTime\\": \\"2024-12-07T10:53:45Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"******2491c84dce913da9fe65******\\",\\n \\"Name\\": \\"example-workflow-***\\",\\n \\"Status\\": \\"Active\\",\\n \\"Type\\": \\"Common\\",\\n \\"CreateTime\\": \\"2025-03-21T01:48:49Z\\",\\n \\"ModifiedTime\\": \\"2025-02-23 10:19:37 +0800\\",\\n \\"MediaType\\": \\"OSS\\"\\n },\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\"\\n }\\n ],\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + 'title' => '遍历工作流任务实例', + 'description' => '本接口只返回近 90 天执行实例。', + ], + 'StartAIWorkflow' => [ + 'summary' => '通过调用StartAIWorkflow接口，您可以提交智能工作流任务，从而实现基于智能工作流模板的自动化智能媒体服务流程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => [ + 'title' => '模板ID', + 'description' => '智能工作流模板ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', + ], + ], + [ + 'name' => 'Inputs', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '智能工作流启动参数，Json字符串形式，比如媒资或者直播/RTC流信息等。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "live_url": {'."\n" + .' "Url": "rtmp://test.com/test_app/test_stream?auth_key=test",'."\n" + .' "MaxIdleTime": 20'."\n" + .' },'."\n" + .' "source_language_id": "es"'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息，非必填', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .'"url":"https://test.com"'."\n" + .'}', + ], + ], + [ + 'name' => 'DispatchTag', + 'in' => 'query', + 'schema' => [ + 'description' => '任务标签，非必填', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TaskId' => [ + 'description' => '智能工作流任务ID。', + 'type' => 'string', + 'example' => "\n" + .'********-266c-4bb8-b20c-6faa********', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TaskId\\": \\"\\\\n********-266c-4bb8-b20c-6faa********\\"\\n}","type":"json"}]', + 'title' => '提交智能工作流任务', + 'description' => '- 发起智能工作流任务时，需指定智能工作流模板，可通过[智能媒体服务控制台](https://ims.console.aliyun.com/ai-workflow/template)创建智能工作流模板。', + 'requestParamsDescription' => 'Inputs：在智能工作流模板的开始节点中进行配置，支持多参数、多参数类型，可根据工作流模板的实际流程需要进行定义。可参考如下场景示例：'."\n" + .' '."\n" + .'- 直播翻译：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "live_url": {'."\n" + .' "Url": "rtmp://test.com/test_app/test_stream?auth_key=test",'."\n" + .' "MaxIdleTime": 20'."\n" + .' },'."\n" + .' "source_language_id": "es"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- RTC字幕翻译'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "rtc": {'."\n" + .' "AppId": "xxx",'."\n" + .' "ChannelId": "rtcaitest1",'."\n" + .' "UserId": "userA"'."\n" + .' },'."\n" + .' "source_language_id": "zh",'."\n" + .' "push_app_id": "app_id",'."\n" + .' "push_channel_id": "channel_id",'."\n" + .' "push_uid": "user_id"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- 媒体处理'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "TaskInput":{'."\n" + .' "Type":"OSS",'."\n" + .' "Media": "oss://sashimi-cn-shanghai/test/test.flv"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'StopAIWorkflowTask' => [ + 'summary' => '通过调用该接口，您可以主动停止智能工作流任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceL4UDD6', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能工作流任务ID', + 'type' => 'string', + 'required' => false, + 'example' => '********-266c-4bb8-b20c-6faa********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'TaskId' => [ + 'description' => '智能工作流任务ID', + 'type' => 'string', + 'example' => '********-266c-4bb8-b20c-6faa********', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"TaskId\\": \\"********-266c-4bb8-b20c-6faa********\\"\\n}","type":"json"}]', + 'title' => '停止智能工作流任务', + 'description' => '该接口只用于直播、RTC等实时场景下的智能工作流任务的停止，不支持离线场景的任务停止。', + ], + 'GetAIWorkflowTask' => [ + 'summary' => '通过调用该接口，您可以查询智能工作流任务的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceVYUZ7L', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能工作流任务ID', + 'type' => 'string', + 'required' => false, + 'example' => '********-266c-4bb8-b20c-6faa********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'WorkflowTask' => [ + 'description' => '智能工作流任务信息', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '智能工作流任务ID', + 'type' => 'string', + 'example' => '********-67fd-43aa-9cc1-3e7f********', + ], + 'Status' => [ + 'description' => '任务状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => '运行中', + 'stopped' => '已停止', + 'failed' => '已失败', + 'partial-succeeded' => '部分成功', + 'succeeded' => '已完成', + ], + 'example' => 'succeeded', + ], + 'Inputs' => [ + 'description' => '工作流任务启动参数', + 'type' => 'string', + 'example' => '{\\"source_language_id\\":\\"en\\",\\"live_id\\":123,\\"live_url\\":{\\"url\\":\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\"}}', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2025-07-28T02:17:26Z', + ], + 'FinishTime' => [ + 'description' => '任务完成时间。格式为: yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2025-08-19T02:28:22Z', + ], + 'Workflow' => [ + 'description' => '工作流模板信息', + 'type' => 'object', + 'properties' => [ + 'WorkflowId' => [ + 'description' => '智能工作流模板ID', + 'type' => 'string', + 'example' => '****3f44-f1f6-477e-9364-c5e6c49e****', + ], + 'Name' => [ + 'description' => '工作流模板名称', + 'type' => 'string', + 'example' => 'RealtimeTranslation', + ], + 'Status' => [ + 'description' => '工作流模板状态：'."\n" + .'* Draft：草稿'."\n" + .'* Published：已发布'."\n" + .'* Editing：已发布编辑中', + 'type' => 'string', + 'example' => 'Draft', + ], + 'Type' => [ + 'description' => '模板场景类型', + 'type' => 'string', + 'example' => 'Live', + ], + 'CreateTime' => [ + 'description' => '工作流模板创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2025-08-20T01:35:04Z', + ], + 'ModifiedTime' => [ + 'description' => '工作流模板最后修改时间。格式为：yyyy-MM-ddTHH:mm:ssZ 。', + 'type' => 'string', + 'example' => '2025-08-20T01:35:04Z', + ], + 'Version' => [ + 'description' => '工作流模板版本号信息', + 'type' => 'string', + 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', + ], + 'Graph' => [ + 'description' => '工作流模板拓扑信息', + 'type' => 'string', + 'example' => '{'."\n" + .'"nodes":[...],'."\n" + .'"edges":[...]'."\n" + .'}', + ], + ], + ], + 'NodeResults' => [ + 'description' => '工作流任务的节点结果。Json格式，内容根据工作流配置有变化。', + 'type' => 'string', + 'example' => '{...}', + ], + 'UserData' => [ + 'description' => '用户自定义信息', + 'type' => 'string', + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}', + ], + 'Outputs' => [ + 'description' => '节点输出', + 'type' => 'string', + 'example' => '{'."\n" + .'"result":"test"'."\n" + .'}', + ], + 'Version' => [ + 'description' => '工作流模板版本号信息', + 'type' => 'string', + 'example' => '****ec0a-e3b9-40b1-abf2-6549d00e****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"WorkflowTask\\": {\\n \\"TaskId\\": \\"********-67fd-43aa-9cc1-3e7f********\\",\\n \\"Status\\": \\"succeeded\\",\\n \\"Inputs\\": \\"{\\\\\\\\\\\\\\"source_language_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"live_id\\\\\\\\\\\\\\":123,\\\\\\\\\\\\\\"live_url\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rtmp://test.com.cn/video/638d9088fe4f15ce\\\\\\\\\\\\\\"}}\\",\\n \\"CreateTime\\": \\"2025-07-28T02:17:26Z\\",\\n \\"FinishTime\\": \\"2025-08-19T02:28:22Z\\",\\n \\"Workflow\\": {\\n \\"WorkflowId\\": \\"****3f44-f1f6-477e-9364-c5e6c49e****\\",\\n \\"Name\\": \\"RealtimeTranslation\\",\\n \\"Status\\": \\"Draft\\",\\n \\"Type\\": \\"Live\\",\\n \\"CreateTime\\": \\"2025-08-20T01:35:04Z\\",\\n \\"ModifiedTime\\": \\"2025-08-20T01:35:04Z\\",\\n \\"Version\\": \\"****ec0a-e3b9-40b1-abf2-6549d00e****\\",\\n \\"Graph\\": \\"{\\\\n\\\\\\"nodes\\\\\\":[...],\\\\n\\\\\\"edges\\\\\\":[...]\\\\n}\\"\\n },\\n \\"NodeResults\\": \\"{...}\\",\\n \\"UserData\\": \\"{\\\\\\"NotifyAddress\\\\\\":\\\\\\"http://xx.xx.xxx\\\\\\"}\\",\\n \\"Outputs\\": \\"{\\\\n\\\\\\"result\\\\\\":\\\\\\"test\\\\\\"\\\\n}\\",\\n \\"Version\\": \\"****ec0a-e3b9-40b1-abf2-6549d00e****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询智能工作流任务详情', + ], + 'CreateMediaLiveInputSecurityGroup' => [ + 'summary' => '创建媒体直播输入安全组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组名称', + 'description' => '安全组名称，支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysg', + ], + ], + [ + 'name' => 'WhitelistRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '安全组规则列表', + 'description' => '安全组规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则配置。必须是IPv4格式的IP/子网掩码形式。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.0/24', + ], + 'required' => true, + 'example' => '["10.1.1.0/24", "11.11.11.11/0"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', + 'title' => '创建媒体直播输入安全组', + 'description' => '- 调用本接口创建媒体直播输入安全组。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateMediaLiveInputSecurityGroup' => [ + 'summary' => '更新媒体直播输入安全组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH ', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组名称', + 'description' => '安全组名称。支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysg', + ], + ], + [ + 'name' => 'WhitelistRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '安全组规则列表', + 'description' => '安全组规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则，必须是IPv4格式的IP/子网掩码形式。', + 'type' => 'string', + 'required' => false, + 'example' => '10.1.1.0/24', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '更新媒体直播输入安全组', + 'description' => '- 调用本接口更新媒体直播输入安全组。'."\n" + .'- 仅当媒体直播输入安全组未绑定到媒体直播输入时，允许更新安全组，不允许更新已经绑定了输入的安全组。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetMediaLiveInputSecurityGroup' => [ + 'summary' => '查询媒体直播输入安全组详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组ID', + 'description' => '安全组ID', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + 'SecurityGroup' => [ + 'description' => '安全组配置。', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'Name' => [ + 'description' => '安全组名称。', + 'type' => 'string', + 'example' => 'mysg', + ], + 'WhitelistRules' => [ + 'description' => '安全组规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则。', + 'type' => 'string', + 'example' => '10.1.1.0/24', + ], + ], + 'CreateTime' => [ + 'description' => '安全组创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-06-13T08:31:56Z', + ], + 'InputIds' => [ + 'description' => '安全组关联的输入ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组关联的输入ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\",\\n \\"SecurityGroup\\": {\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mysg\\",\\n \\"WhitelistRules\\": [\\n \\"10.1.1.0/24\\"\\n ],\\n \\"CreateTime\\": \\"2024-06-13T08:31:56Z\\",\\n \\"InputIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询媒体直播输入安全组详情', + 'description' => '- 调用本接口查询媒体直播输入安全组详情。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListMediaLiveInputSecurityGroups' => [ + 'summary' => '查询媒体直播输入安全组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为 100。'."\n" + .'默认值：'."\n" + .'当不设置值或设置的值小于 10 时，默认值为 10。'."\n" + .'当设置的值大于 100 时，默认值为 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时跳过的条目数。'."\n" + .'当跳过的条目数超过符合条件的条目总数时，会返回空列表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次 API 调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询的排序规则，用于按安全组的创建时间排序。默认是asc。'."\n" + .'可选值：desc（降序排序），asc（升序排序）。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询的关键词。对安全组ID/名称进行搜索，均支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '123e4567-e89b-12d3-a456-426614174000', + ], + 'SecurityGroups' => [ + 'title' => '安全组配置列表', + 'description' => '安全组配置列表', + 'type' => 'array', + 'items' => [ + 'title' => '安全组配置', + 'description' => '安全组配置', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'Name' => [ + 'title' => '安全组名称', + 'description' => '安全组名称。', + 'type' => 'string', + 'example' => 'mysg', + ], + 'WhitelistRules' => [ + 'title' => '安全组规则列表', + 'description' => '安全组规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则。', + 'type' => 'string', + 'example' => '10.1.1.0/24"', + ], + ], + 'CreateTime' => [ + 'description' => '安全组创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'InputIds' => [ + 'description' => '安全组关联的输入ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组关联的输入ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '查询凭证。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '符合分页条件查询的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123e4567-e89b-12d3-a456-426614174000\\",\\n \\"SecurityGroups\\": [\\n {\\n \\"SecurityGroupId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mysg\\",\\n \\"WhitelistRules\\": [\\n \\"10.1.1.0/24\\\\\\"\\"\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"InputIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '查询媒体直播输入安全组列表', + 'description' => '- 调用本接口查询媒体直播输入安全组列表。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteMediaLiveInputSecurityGroup' => [ + 'summary' => '删除媒体直播输入安全组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'SecurityGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组ID', + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除媒体直播输入安全组', + 'description' => '- 调用本接口删除媒体直播输入安全组。'."\n" + .'- 仅当媒体直播输入安全组未绑定到媒体直播输入时，允许删除安全组，不允许删除已经绑定了输入的安全组。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateMediaLiveInput' => [ + 'summary' => '创建媒体直播输入。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入名称', + 'description' => '输入实例名称。支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'myinput', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入类型', + 'description' => '输入类型。'."\n" + .'可选值：RTMP_PUSH，RTMP_PULL，SRT_PUSH，SRT_PULL，MEDIA_CONNECT。', + 'type' => 'string', + 'required' => true, + 'example' => 'RTMP_PUSH', + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '绑定的安全组ID列表', + 'description' => '要绑定的安全组ID列表，Type为PUSH类型时必填。', + 'type' => 'array', + 'items' => [ + 'description' => '要绑定的安全组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'G6G4X5T4SZYPSTT5', + ], + 'required' => false, + 'example' => '["G6G4X5T4SZYPSTT5"]', + ], + ], + [ + 'name' => 'InputSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '输入设置', + 'description' => '输入设置。最多2个，对应主输入和备输入。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamName' => [ + 'description' => '推流的流名称，Type为PUSH类型时必填。长度限制英文255字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'mystream', + ], + 'SourceUrl' => [ + 'description' => '拉流的流地址，Type为PULL类型时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://domain/app/stream', + ], + 'FlowId' => [ + 'description' => 'MediaConnect Flow的Flow ID，Type为MEDIA_CONNECT时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '******81-9693-40dc-bbab-db5e49******', + ], + 'FlowOutputName' => [ + 'description' => 'MediaConnect Flow的输出名称，Type为MEDIA_CONNECT时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'myFlowOutputName', + ], + 'SrtMaxBitrate' => [ + 'title' => 'SRT输入的最大码率', + 'description' => 'SRT流的最大码率，单位bps。取值范围[100, 100000000]。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3000000', + ], + 'SrtLatency' => [ + 'title' => 'SRT输入的延迟', + 'description' => 'SRT流的延迟，单位ms。取值范围[100, 10000]。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'SrtPassphrase' => [ + 'title' => 'SRT输入的连接密码', + 'description' => 'SRT加密配置，SRT流的密码，由10~79个ASCII编码可见的字符组成。Type为SRT_PUSH，SRT_PULL时选填。'."\n" + ."\n" + .'如果加密配置不为空，则所有 SRT 客户端必须使用正确的密码才能发布或播放，否则 SRT 连接将被拒绝。', + 'type' => 'string', + 'required' => false, + 'example' => 'srtencryption', + ], + 'SrtPbKeyLen' => [ + 'title' => 'SRT输入的密钥长度', + 'description' => 'SRT加密配置，SRT流的密钥长度。可选值：0, 16, 24, 32。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'InputId' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', + 'title' => '创建媒体直播输入', + 'description' => '- 调用本接口创建媒体直播输入。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateMediaLiveInput' => [ + 'summary' => '更新媒体直播输入。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputId', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入实例名称', + 'description' => '输入实例名称。支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'myinput', + ], + ], + [ + 'name' => 'SecurityGroupIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '绑定的安全组ID列表', + 'description' => '要绑定的安全组ID列表，Type为PUSH类型时必填。', + 'type' => 'array', + 'items' => [ + 'description' => '要绑定的安全组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'G6G4X5T4SZYPSTT5', + ], + 'required' => false, + 'example' => '["G6G4X5T4SZYPSTT5"]', + ], + ], + [ + 'name' => 'InputSettings', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '输入配置', + 'description' => '输入设置。最多2个，对应主输入和备输入。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'MediaConnect Flow的Flow ID，Type为MEDIA_CONNECT时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '******81-9693-40dc-bbab-db5e49******', + ], + 'SourceUrl' => [ + 'description' => '拉流的流地址，Type为PULL类型时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://domain/app/stream', + ], + 'StreamName' => [ + 'description' => '推流的流名称，Type为PUSH类型时必填。长度限制英文255字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'mystream', + ], + 'SrtPassphrase' => [ + 'title' => 'SRT输入的连接密码', + 'description' => 'SRT加密配置，SRT流的密码，由10~79个ASCII编码可见的字符组成。Type为SRT_PUSH，SRT_PULL时选填。'."\n" + ."\n" + .'如果加密配置不为空，则所有 SRT 客户端必须使用正确的密码才能发布或播放，否则 SRT 连接将被拒绝。', + 'type' => 'string', + 'required' => false, + 'example' => 'srtencryption', + ], + 'SrtMaxBitrate' => [ + 'title' => 'SRT输入的最大码率', + 'description' => 'SRT流的最大码率，单位bps。取值范围[100, 100000000]。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3000000', + ], + 'FlowOutputName' => [ + 'description' => 'MediaConnect Flow的输出名称，Type为MEDIA_CONNECT时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'myFlowOutputName', + ], + 'SrtLatency' => [ + 'title' => 'SRT输入的延迟', + 'description' => 'SRT流的延迟，单位ms。取值范围[100, 10000]。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'SrtPbKeyLen' => [ + 'title' => 'SRT输入的密钥长度', + 'description' => 'SRT加密配置，SRT流的密钥长度。可选值：0, 16, 24, 32。Type为SRT_PUSH，SRT_PULL时选填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '更新媒体直播输入', + 'description' => '- 调用本接口更新媒体直播输入。'."\n" + .'- 仅当媒体直播输入未绑定到媒体直播频道时，允许更新输入，不允许更新已经绑定了频道的输入。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetMediaLiveInput' => [ + 'summary' => '查询媒体直播输入详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputId', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Input' => [ + 'title' => '输入配置', + 'description' => '输入配置。', + 'type' => 'object', + 'properties' => [ + 'InputId' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'Name' => [ + 'title' => '输入实例名称', + 'description' => '输入实例名称。', + 'type' => 'string', + 'example' => 'myinput', + ], + 'Type' => [ + 'title' => '输入类型', + 'description' => '输入类型。', + 'type' => 'string', + 'example' => 'RTMP_PUSH', + ], + 'InputInfos' => [ + 'title' => '输入信息列表', + 'description' => '输入配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DestHost' => [ + 'title' => 'PUSH类型推流地址', + 'description' => 'PUSH类型生成的推流地址。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream', + ], + 'StreamName' => [ + 'title' => '流名称', + 'description' => '推流的流名称，输入为PUSH类型时返回。', + 'type' => 'string', + 'example' => 'mystream', + ], + 'SourceUrl' => [ + 'title' => 'PULL类型拉流地址', + 'description' => '拉流的流地址，输入为PULL类型时返回。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream', + ], + 'MonitorUrl' => [ + 'description' => '输入监看地址，用于监播。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream_for_monitor', + ], + 'FlowId' => [ + 'description' => 'MediaConnect Flow的Flow ID。', + 'type' => 'string', + 'example' => '******81-9693-40dc-bbab-db5e49******', + ], + 'FlowOutputName' => [ + 'description' => 'MediaConnect Flow的输出名称。', + 'type' => 'string', + 'example' => 'myFlowOutputName', + ], + 'SrtMaxBitrate' => [ + 'description' => 'SRT流的最大码率，单位bps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000000', + ], + 'SrtLatency' => [ + 'description' => 'SRT流的延迟，单位ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'SrtPassphrase' => [ + 'description' => 'SRT加密配置，SRT流的密码。', + 'type' => 'string', + 'example' => 'srtencryption', + ], + 'SrtPbKeyLen' => [ + 'description' => 'SRT加密配置，SRT流的密钥长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '输入创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'ChannelIds' => [ + 'description' => '输入关联的频道ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入关联的频道ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + 'SecurityGroupIds' => [ + 'title' => '关联的安全组ID', + 'description' => '输入关联的安全组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入关联的安全组ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Input\\": {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"myinput\\",\\n \\"Type\\": \\"RTMP_PUSH\\",\\n \\"InputInfos\\": [\\n {\\n \\"DestHost\\": \\"rtmp://domain/app/stream\\",\\n \\"StreamName\\": \\"mystream\\",\\n \\"SourceUrl\\": \\"rtmp://domain/app/stream\\",\\n \\"MonitorUrl\\": \\"rtmp://domain/app/stream_for_monitor\\",\\n \\"FlowId\\": \\"******81-9693-40dc-bbab-db5e49******\\",\\n \\"FlowOutputName\\": \\"myFlowOutputName\\",\\n \\"SrtMaxBitrate\\": 3000000,\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"srtencryption\\",\\n \\"SrtPbKeyLen\\": 16\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"ChannelIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询媒体直播输入详情', + 'description' => '- 调用本接口查询媒体直播输入详情。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListMediaLiveInputs' => [ + 'summary' => '查询媒体直播输入列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为 100。'."\n" + .'默认值：'."\n" + .'当不设置值或设置的值小于 10 时，默认值为 10。'."\n" + .'当设置的值大于 100 时，默认值为 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时跳过的条目数。'."\n" + .'当跳过的条目数超过符合条件的条目总数时，会返回空列表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次 API 调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => '指定查询的排序规则，用于按输入的创建时间排序。默认是asc。'."\n" + .'可选值：desc（降序排序），asc（升序排序）。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询的关键词。对输入ID/名称进行搜索，均支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Types', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => '指定查询的输入类型，可以由多个输入类型组成一个 JSON 数组，输入类型值之间用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '["RTMP_PUSH","SRT_PULL"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Inputs' => [ + 'title' => '输入配置列表', + 'description' => '输入列表。', + 'type' => 'array', + 'items' => [ + 'title' => '输入配置', + 'description' => '输入配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '输入类型', + 'description' => '输入类型。', + 'type' => 'string', + 'example' => 'RTMP_PUSH', + ], + 'CreateTime' => [ + 'description' => '输入创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'InputId' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'InputInfos' => [ + 'title' => '输入信息列表', + 'description' => '输入配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'MediaConnect Flow的Flow ID。', + 'type' => 'string', + 'example' => '******81-9693-40dc-bbab-db5e49******', + ], + 'SourceUrl' => [ + 'title' => 'PULL类型拉流地址', + 'description' => '拉流的流地址，输入为PULL类型时返回。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream', + ], + 'StreamName' => [ + 'title' => '流名称', + 'description' => '推流的流名称，输入为PUSH类型时返回。', + 'type' => 'string', + 'example' => 'mystream', + ], + 'MonitorUrl' => [ + 'description' => '输入监看地址，用于监播。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream_for_monitor', + ], + 'SrtPassphrase' => [ + 'description' => 'SRT加密配置，SRT流的密码。', + 'type' => 'string', + 'example' => 'srtencryption', + ], + 'SrtMaxBitrate' => [ + 'description' => 'SRT流的最大码率，单位bps。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000000', + ], + 'FlowOutputName' => [ + 'description' => 'MediaConnect Flow的输出名称。', + 'type' => 'string', + 'example' => 'myFlowOutputName', + ], + 'SrtLatency' => [ + 'description' => 'SRT流的延迟，单位ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'DestHost' => [ + 'title' => 'PUSH类型推流地址', + 'description' => 'PUSH类型生成的推流地址。', + 'type' => 'string', + 'example' => 'rtmp://domain/app/stream', + ], + 'SrtPbKeyLen' => [ + 'description' => 'SRT加密配置，SRT流的密钥长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + 'SecurityGroupIds' => [ + 'title' => '关联的安全组ID', + 'description' => '输入关联的安全组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入关联的安全组ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + 'ChannelIds' => [ + 'description' => '输入关联的频道ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入关联的频道ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + 'Name' => [ + 'title' => '输入实例名称', + 'description' => '输入实例名称。', + 'type' => 'string', + 'example' => 'myinput', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '查询凭证。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'TotalCount' => [ + 'description' => '符合分页条件查询的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Inputs\\": [\\n {\\n \\"Type\\": \\"RTMP_PUSH\\",\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputInfos\\": [\\n {\\n \\"FlowId\\": \\"******81-9693-40dc-bbab-db5e49******\\",\\n \\"SourceUrl\\": \\"rtmp://domain/app/stream\\",\\n \\"StreamName\\": \\"mystream\\",\\n \\"MonitorUrl\\": \\"rtmp://domain/app/stream_for_monitor\\",\\n \\"SrtPassphrase\\": \\"srtencryption\\",\\n \\"SrtMaxBitrate\\": 3000000,\\n \\"FlowOutputName\\": \\"myFlowOutputName\\",\\n \\"SrtLatency\\": 1000,\\n \\"DestHost\\": \\"rtmp://domain/app/stream\\",\\n \\"SrtPbKeyLen\\": 16\\n }\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"ChannelIds\\": [\\n \\"SEGK5KA6KYKAWQQH\\"\\n ],\\n \\"Name\\": \\"myinput\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"TotalCount\\": 200\\n}","type":"json"}]', + 'title' => '查询媒体直播输入列表', + 'description' => '- 调用本接口查询媒体直播输入列表。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteMediaLiveInput' => [ + 'summary' => '删除媒体直播输入。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputId', + 'in' => 'formData', + 'schema' => [ + 'title' => '输入ID', + 'description' => '输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除媒体直播输入', + 'description' => '- 调用本接口删除媒体直播输入。'."\n" + .'- 仅当媒体直播输入未绑定到媒体直播频道时，允许删除输入，不允许删除已经绑定了频道的输入。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateMediaLiveChannel' => [ + 'summary' => '创建媒体直播频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组名称', + 'description' => '频道名称。支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'mych', + ], + ], + [ + 'name' => 'InputAttachments', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '输入绑定设置', + 'description' => '输入绑定设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InputId' => [ + 'title' => '绑定的输入ID', + 'description' => '绑定的输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'myinput', + ], + 'LanguageName' => [ + 'description' => '语言名称，仅rtmp类型输入有效，表示output使用的Name标签。'."\n" + .'该字段长度限制为英文32字符，支持以下字符类型：'."\n" + .'- Unicode各国语言的字母：包括拉丁字母（如英语、法语）、中文、阿拉伯字母以及其他语言的字母。'."\n" + .'- 数字：允许使用0-9的数字字符。 '."\n" + .'- 英文下划线 (_) '."\n" + .'- 英文中划线 (-)'."\n" + .'- 空格，空格可以出现在字段中间，不能出现在首尾。', + 'type' => 'string', + 'required' => false, + 'example' => 'English', + ], + 'AudioSelectors' => [ + 'title' => '音频选择器列表', + 'description' => '音频选择器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'myselector', + ], + 'AudioLanguageSelection' => [ + 'title' => '语言选择器', + 'description' => '语言选择器。', + 'type' => 'object', + 'properties' => [ + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码。3字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'AudioPidSelection' => [ + 'title' => 'PID选择器', + 'description' => 'PID选择器。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'title' => 'PID', + 'description' => '输入源流的Pid。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'AudioTrackSelection' => [ + 'title' => '音轨选择器', + 'description' => 'track选择器。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrackId' => [ + 'title' => '音轨ID', + 'description' => '输入源流的TrackId，从1开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'OutputGroups', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '输出组详细配置', + 'description' => '输出组配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'group1', + ], + 'Type' => [ + 'title' => '输出组类型', + 'description' => '输出组类型。'."\n" + .'目前支持 MediaPackage。', + 'type' => 'string', + 'required' => true, + 'example' => 'MediaPackage', + ], + 'Outputs' => [ + 'title' => '输出列表设置', + 'description' => '输出列表设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出名称', + 'description' => '输出名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'output1', + ], + 'MediaType' => [ + 'title' => '输出的媒体类型。0:音视频，1:纯音频，2:纯视频。', + 'description' => '输出的媒体类型，枚举。可选值：'."\n" + .'- 0：音视频。'."\n" + .'- 1：纯音频。设置为纯音频时，不允许引用视频设置。'."\n" + .'- 2：纯视频。设置为纯视频时，不允许引用音频设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MediaPackageOutputSetting' => [ + 'title' => '输出组类型为MediaPackage时的设置', + 'description' => '输出组类型为MediaPackage时的输出设置。', + 'type' => 'object', + 'properties' => [ + 'NameModifier' => [ + 'title' => 'manifest后缀', + 'description' => 'manifest后缀，一般用于子m3u8命名。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文40字符。', + 'type' => 'string', + 'required' => false, + 'example' => '480p', + ], + 'AudioGroupId' => [ + 'title' => 'manifest音频组id设置', + 'description' => 'manifest音频组id设置。通过指定 AudioGroupId，可以将多个音频轨道归为同一组，以便于在播放时选择音轨。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文40字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'audiogroup', + ], + ], + 'required' => false, + ], + 'VideoSettingName' => [ + 'title' => '引用的视频设置名称', + 'description' => '引用的视频设置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myVideo1', + ], + 'AudioSettingNames' => [ + 'title' => '引用的音频设置名称', + 'description' => '引用的音频设置名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的音频设置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myAudio1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'MediaPackageGroupSetting' => [ + 'title' => 'MediaPackage输出组设置', + 'description' => '输出组类型为MediaPackage时的输出组设置。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => 'MediaPackage的GroupName', + 'description' => '引用的MediaPackage的GroupName。', + 'type' => 'string', + 'required' => true, + 'example' => 'myPackageGroup', + ], + 'ChannelName' => [ + 'title' => 'MediaPackage的ChannelName', + 'description' => '引用的MediaPackage的ChannelName。', + 'type' => 'string', + 'required' => true, + 'example' => 'myPackageChannel', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'AudioSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '音频设置', + 'description' => '音频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频设置名称', + 'description' => '音频设置名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'audio1', + ], + 'AudioSelectorName' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1', + ], + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码，3字符。'."\n" + .'当selector选择的音轨对应输出有语言代码，优先使用selector的语言代码；若选择器选择的音轨没有语言代码或者没有和选择器匹配的音轨，则使用该语言代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + 'LanguageName' => [ + 'title' => 'audio类型m3u8切片的名称', + 'description' => '语言名称，仅rtmp类型输入有效，表示output使用的Name标签。'."\n" + .'该字段长度限制为英文32字符，支持以下字符类型：'."\n" + .'- Unicode各国语言的字母：包括拉丁字母（如英语、法语）、中文、阿拉伯字母以及其他语言的字母。'."\n" + .'- 数字：允许使用0-9的数字字符。 '."\n" + .'- 英文下划线 (_) '."\n" + .'- 英文中划线 (-)'."\n" + .'- 空格，空格可以出现在字段中间，不能出现在首尾。', + 'type' => 'string', + 'required' => false, + 'example' => 'English', + ], + 'AudioCodec' => [ + 'title' => '音频编码类型', + 'description' => '音频编码类型。若填空则copy，即随源。'."\n" + .'可选值：aac，libfdk_aac。', + 'type' => 'string', + 'required' => false, + 'example' => 'libfdk_aac', + ], + 'AudioCodecSetting' => [ + 'title' => '音频编码设置', + 'description' => '音频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '音频编码级别', + 'description' => '音频编码级别。'."\n" + .'当codec="aac"时，支持"AAC-LOW"，"AAC-MAIN"。'."\n" + .'当codec="libfdk_aac"时，支持："AAC-LOW"，"AAC-HE"，"AAC-HEV2"。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC-LOW', + ], + 'Bitrate' => [ + 'title' => '音频比特率', + 'description' => '音频比特率，单位bps。范围: [8000, 1000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200000', + ], + 'SampleRate' => [ + 'title' => '音频采样率', + 'description' => '音频采样率。单位: Hz。取值范围: 22050、32000、44100、48000、96000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '44100', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'VideoSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '视频设置', + 'description' => '视频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视频设置名称', + 'description' => '视频设置名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'video1', + ], + 'Width' => [ + 'title' => '分辨率宽', + 'description' => '视频分辨率宽，不设置或者设置为0则按Height自适应缩放。'."\n" + ."\n" + .'取值范围：'."\n" + .'- 对于普通转码，需要满足max(Width, Height) < 3840，min(Width, Height) < 2160'."\n" + .'- 对于窄带高清转码，需要满足max(Width, Height) < 1920，min(Width, Height) < 1080', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1280', + ], + 'Height' => [ + 'title' => '分辨率高', + 'description' => '视频分辨率高，不设置或者设置为0则按Width自适应缩放。'."\n" + ."\n" + .'取值范围：'."\n" + .'- 对于普通转码，需要满足max(Width, Height) < 3840，min(Width, Height) < 2160'."\n" + .'- 对于窄带高清转码，需要满足max(Width, Height) < 1920，min(Width, Height) < 1080', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + 'VideoCodec' => [ + 'title' => '视频编码类型', + 'description' => '视频编码类型。'."\n" + .'可选值：H264，H265。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264', + ], + 'VideoCodecSetting' => [ + 'title' => '视频编码设置', + 'description' => '视频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'title' => '视频编码速率设置', + 'description' => '视频编码速率设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'title' => '视频比特率', + 'description' => '视频比特率，单位bps。不填或0则随源。范围:[50000,6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2500000', + ], + 'RateControlMode' => [ + 'title' => '视频编码码控规则', + 'description' => '视频编码码控规则。'."\n" + .'可选值：CBR、ABR和VBR。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABR', + ], + 'MaxBitrate' => [ + 'title' => '视频编码最大比特率', + 'description' => '视频编码最大比特率，单位bps。范围: [100000, 6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6000000', + ], + 'BufferSize' => [ + 'title' => '视频编码缓冲区大小', + 'description' => '视频编码缓冲区大小，单位bps。范围: [100000, 6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6000000', + ], + ], + 'required' => false, + ], + 'Framerate' => [ + 'title' => '视频帧率设置', + 'description' => '视频帧率设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'FramerateControl' => [ + 'title' => '视频帧率设置模式', + 'description' => '视频帧率设置模式。'."\n" + .'可选值：SPECIFIED（固定帧率），FROM_SOURCE（帧率随源）。', + 'type' => 'string', + 'required' => false, + 'example' => 'SPECIFIED', + ], + 'FramerateNumerator' => [ + 'title' => '视频帧率分子', + 'description' => '固定帧率的帧率分子，当视频帧率设置模式为SPECIFIED时必传。范围: [1,60]，需要能整除分母。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + 'FramerateDenominator' => [ + 'title' => '视频帧率分母', + 'description' => '固定帧率的帧率分母，当视频帧率设置模式为SPECIFIED时必传。范围: [1,60]，需要能被分子整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'Gop' => [ + 'title' => '视频GOP设置', + 'description' => '视频GOP设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'GopSizeUnits' => [ + 'title' => '视频GOP长度单位', + 'description' => '视频GOP长度单位。'."\n" + .'可选值：FRAMES（单位帧），SECONDS（单位秒）', + 'type' => 'string', + 'required' => false, + 'example' => 'FRAMES', + ], + 'GopSize' => [ + 'title' => '视频GOP大小', + 'description' => '视频GOP大小。'."\n" + .'当长度单位为SECONDS时，取值范围为[1, 20]。当长度单位为FRAMES时，取值范围为[1, 3000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + 'BframesNum' => [ + 'title' => 'B帧数', + 'description' => 'B帧数。范围: [1, 3]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'CodecDetail' => [ + 'title' => '视频编码详情设置', + 'description' => '视频编码详情设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '视频编码配置', + 'description' => 'H264编码质量等级。BASELINE、HIGH、MAIN。默认为MAIN。仅H264编码器设置生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'MAIN', + ], + 'Level' => [ + 'title' => '视频编码级别', + 'description' => '视频编码级别。暂不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264_LEVEL_AUTO', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'VideoCodecType' => [ + 'title' => '视频转码方式（普通转码、窄带高清转码等）', + 'description' => '视频转码方式，枚举。可选值：'."\n" + ."\n" + .'- NORMAL：普通转码。'."\n" + .'- NBHD：窄带高清转码。'."\n" + ."\n" + .'不配置时默认为普通转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'ChannelId' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\"\\n}","type":"json"}]', + 'title' => '创建媒体直播频道', + 'description' => '- 调用本接口创建媒体直播频道。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateMediaLiveChannel' => [ + 'summary' => '更新媒体直播频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '安全组名称', + 'description' => '频道名称。支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'mych', + ], + ], + [ + 'name' => 'InputAttachments', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '输入绑定设置', + 'description' => '输入绑定设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InputId' => [ + 'title' => '绑定的输入ID', + 'description' => '绑定的输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'myinput', + ], + 'LanguageName' => [ + 'description' => '语言名称，仅rtmp类型输入有效，表示output使用的Name标签。'."\n" + .'该字段长度限制为英文32字符，支持以下字符类型：'."\n" + .'- Unicode各国语言的字母：包括拉丁字母（如英语、法语）、中文、阿拉伯字母以及其他语言的字母。'."\n" + .'- 数字：允许使用0-9的数字字符。 '."\n" + .'- 英文下划线 (_) '."\n" + .'- 英文中划线 (-)'."\n" + .'- 空格，空格可以出现在字段中间，不能出现在首尾。', + 'type' => 'string', + 'required' => false, + 'example' => 'English', + ], + 'AudioSelectors' => [ + 'title' => '音频选择器列表', + 'description' => '音频选择器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'myselector', + ], + 'AudioLanguageSelection' => [ + 'title' => '语言选择器', + 'description' => '语言选择器。', + 'type' => 'object', + 'properties' => [ + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码。3字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'eng', + ], + ], + 'required' => false, + ], + 'AudioPidSelection' => [ + 'title' => 'PID选择器', + 'description' => 'PID选择器。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'title' => 'PID', + 'description' => '输入源流的Pid。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + 'required' => false, + ], + 'AudioTrackSelection' => [ + 'title' => '音轨选择器', + 'description' => 'track选择器。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrackId' => [ + 'title' => '音轨ID', + 'description' => '输入源流的TrackId，从1开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'OutputGroups', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '输出组详细配置', + 'description' => '输出组配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'group1', + ], + 'Type' => [ + 'title' => '输出组类型', + 'description' => '输出组类型。'."\n" + .'目前支持 MediaPackage。', + 'type' => 'string', + 'required' => true, + 'example' => 'MediaPackage', + ], + 'Outputs' => [ + 'title' => '输出列表设置', + 'description' => '输出列表设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出名称', + 'description' => '输出名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'output1', + ], + 'MediaType' => [ + 'title' => '输出的媒体类型。0:音视频，1:纯音频，2:纯视频。', + 'description' => '输出的媒体类型，枚举。可选值：'."\n" + .'- 0：音视频。'."\n" + .'- 1：纯音频。设置为纯音频时，不允许引用视频设置。'."\n" + .'- 2：纯视频。设置为纯视频时，不允许引用音频设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MediaPackageOutputSetting' => [ + 'title' => '输出组类型为MediaPackage时的设置', + 'description' => '输出组类型为MediaPackage时的输出设置。', + 'type' => 'object', + 'properties' => [ + 'NameModifier' => [ + 'title' => 'manifest后缀', + 'description' => 'manifest后缀，一般用于子m3u8命名。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文40字符。', + 'type' => 'string', + 'required' => false, + 'example' => '480p', + ], + 'AudioGroupId' => [ + 'title' => 'manifest音频组id设置', + 'description' => 'manifest音频组id设置。通过指定 AudioGroupId，可以将多个音频轨道归为同一组，以便于在播放时选择音轨。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文40字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'audiogroup', + ], + ], + 'required' => false, + ], + 'VideoSettingName' => [ + 'title' => '引用的视频设置名称', + 'description' => '引用的视频设置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myVideo1', + ], + 'AudioSettingNames' => [ + 'title' => '引用的音频设置名称', + 'description' => '引用的音频设置名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的音频设置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'myAudio1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'MediaPackageGroupSetting' => [ + 'title' => 'MediaPackage输出组设置', + 'description' => '输出组类型为MediaPackage时的输出组设置。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => 'MediaPackage的GroupName', + 'description' => '引用的MediaPackage的GroupName。', + 'type' => 'string', + 'required' => true, + 'example' => 'myPackageGroup', + ], + 'ChannelName' => [ + 'title' => 'MediaPackage的ChannelName', + 'description' => '引用的MediaPackage的ChannelName。', + 'type' => 'string', + 'required' => true, + 'example' => 'myPackageChannel', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'AudioSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '音频设置', + 'description' => '音频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频设置名称', + 'description' => '音频设置名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'audio1', + ], + 'AudioSelectorName' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1', + ], + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码，3字符。'."\n" + .'当selector选择的音轨对应输出有语言代码，优先使用selector的语言代码；若选择器选择的音轨没有语言代码或者没有和选择器匹配的音轨，则使用该语言代码。', + 'type' => 'string', + 'required' => false, + 'example' => 'eng', + ], + 'LanguageName' => [ + 'title' => 'audio类型m3u8切片的名称', + 'description' => '语言名称，仅rtmp类型输入有效，表示output使用的Name标签。'."\n" + .'该字段长度限制为英文32字符，支持以下字符类型：'."\n" + .'- Unicode各国语言的字母：包括拉丁字母（如英语、法语）、中文、阿拉伯字母以及其他语言的字母。'."\n" + .'- 数字：允许使用0-9的数字字符。 '."\n" + .'- 英文下划线 (_) '."\n" + .'- 英文中划线 (-)'."\n" + .'- 空格，空格可以出现在字段中间，不能出现在首尾。', + 'type' => 'string', + 'required' => false, + 'example' => 'English', + ], + 'AudioCodec' => [ + 'title' => '音频编码类型', + 'description' => '音频编码类型。若填空则copy，即随源。'."\n" + .'可选值：aac，libfdk_aac。', + 'type' => 'string', + 'required' => false, + 'example' => 'libfdk_aac', + ], + 'AudioCodecSetting' => [ + 'title' => '音频编码设置', + 'description' => '音频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '音频编码级别', + 'description' => '音频编码级别。'."\n" + .'当codec="aac"时，支持"AAC-LOW"，"AAC-MAIN"。'."\n" + .'当codec="libfdk_aac"时，支持："AAC-LOW"，"AAC-HE"，"AAC-HEV2"。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAC-LOW', + ], + 'Bitrate' => [ + 'title' => '音频比特率', + 'description' => '音频比特率，单位bps。范围: [8000, 1000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200000', + ], + 'SampleRate' => [ + 'title' => '音频采样率', + 'description' => '音频采样率。单位: Hz。取值范围: 22050、32000、44100、48000、96000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '44100', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'VideoSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '视频设置', + 'description' => '视频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视频设置名称', + 'description' => '视频设置名称。'."\n" + .'支持英文+数字+英文短划线(-)、下划线(_)。长度限制英文64字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'video1', + ], + 'Width' => [ + 'title' => '分辨率宽', + 'description' => '视频分辨率宽，不设置或者设置为0则按Height自适应缩放。'."\n" + ."\n" + .'取值范围：'."\n" + .'- 对于普通转码，需要满足max(Width, Height) < 3840，min(Width, Height) < 2160'."\n" + .'- 对于窄带高清转码，需要满足max(Width, Height) < 1920，min(Width, Height) < 1080', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1280', + ], + 'Height' => [ + 'title' => '分辨率高', + 'description' => '视频分辨率高，不设置或者设置为0则按Width自适应缩放。'."\n" + ."\n" + .'取值范围：'."\n" + .'- 对于普通转码，需要满足max(Width, Height) < 3840，min(Width, Height) < 2160'."\n" + .'- 对于窄带高清转码，需要满足max(Width, Height) < 1920，min(Width, Height) < 1080', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '720', + ], + 'VideoCodec' => [ + 'title' => '视频编码类型', + 'description' => '视频编码类型。'."\n" + .'可选值：H264，H265。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264', + ], + 'VideoCodecSetting' => [ + 'title' => '视频编码设置', + 'description' => '视频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'title' => '视频编码速率设置', + 'description' => '视频编码速率设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'title' => '视频比特率', + 'description' => '视频比特率，单位bps。不填或0则随源。范围:[50000,6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2500000', + ], + 'RateControlMode' => [ + 'title' => '视频编码码控规则', + 'description' => '视频编码码控规则。'."\n" + .'可选值：CBR、ABR和VBR。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABR', + ], + 'MaxBitrate' => [ + 'title' => '视频编码最大比特率', + 'description' => '视频编码最大比特率，单位bps。范围: [100000, 6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6000000', + ], + 'BufferSize' => [ + 'title' => '视频编码缓冲区大小', + 'description' => '视频编码缓冲区大小，单位bps。范围: [100000, 6000000]，需要能被1000整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6000000', + ], + ], + 'required' => false, + ], + 'Framerate' => [ + 'title' => '视频帧率设置', + 'description' => '视频帧率设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'FramerateControl' => [ + 'title' => '视频帧率设置模式', + 'description' => '视频帧率设置模式。'."\n" + .'可选值：SPECIFIED（固定帧率），FROM_SOURCE（帧率随源）。', + 'type' => 'string', + 'required' => false, + 'example' => 'SPECIFIED', + ], + 'FramerateNumerator' => [ + 'title' => '视频帧率分子', + 'description' => '固定帧率的帧率分子，当视频帧率设置模式为SPECIFIED时必传。范围: [1,60]，需要能整除分母。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + 'FramerateDenominator' => [ + 'title' => '视频帧率分母', + 'description' => '固定帧率的帧率分母，当视频帧率设置模式为SPECIFIED时必传。范围: [1,60]，需要能被分子整除。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'Gop' => [ + 'title' => '视频GOP设置', + 'description' => '视频GOP设置，不设置则随源。', + 'type' => 'object', + 'properties' => [ + 'GopSizeUnits' => [ + 'title' => '视频GOP长度单位', + 'description' => '视频GOP长度单位。'."\n" + .'可选值：FRAMES（单位帧），SECONDS（单位秒）', + 'type' => 'string', + 'required' => false, + 'example' => 'FRAMES', + ], + 'GopSize' => [ + 'title' => '视频GOP大小', + 'description' => '视频GOP大小。'."\n" + .'当长度单位为SECONDS时，取值范围为[1, 20]。当长度单位为FRAMES时，取值范围为[1, 3000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + 'BframesNum' => [ + 'title' => 'B帧数', + 'description' => 'B帧数。范围: [1, 3]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'CodecDetail' => [ + 'title' => '视频编码详情设置', + 'description' => '视频编码详情设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '视频编码配置', + 'description' => 'H264编码质量等级。BASELINE、HIGH、MAIN。默认为MAIN。仅H264编码器设置生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'MAIN', + ], + 'Level' => [ + 'title' => '视频编码级别', + 'description' => '视频编码级别。暂不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'H264_LEVEL_AUTO', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'VideoCodecType' => [ + 'title' => '视频转码方式（普通转码、窄带高清转码等）', + 'description' => '视频转码方式，枚举。可选值：'."\n" + ."\n" + .'- NORMAL：普通转码。'."\n" + .'- NBHD：窄带高清转码。'."\n" + ."\n" + .'不配置时默认为普通转码。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '更新媒体直播频道', + 'description' => '- 调用本接口更新媒体直播频道。'."\n" + .'- 仅当媒体直播频道未启动时，允许更新频道，不允许更新正在运行的频道。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetMediaLiveChannel' => [ + 'summary' => '查询媒体直播频道详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Channel' => [ + 'title' => '频道配置', + 'description' => '频道配置。', + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'Name' => [ + 'title' => '频道名称', + 'description' => '频道名称。', + 'type' => 'string', + 'example' => 'mych', + ], + 'State' => [ + 'title' => '频道状态', + 'description' => '频道状态。'."\n" + .'可能的返回值包括：IDLE（空闲中）, STARTING（启动中）, RUNNING（运行中）, RECOVERING（恢复中）， STOPPING（停止中）。', + 'type' => 'string', + 'example' => 'IDLE', + ], + 'InputAttachments' => [ + 'title' => '输入绑定设置', + 'description' => '输入绑定设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InputId' => [ + 'title' => '绑定的输入ID', + 'description' => '绑定的输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'InputName' => [ + 'title' => '输入名称', + 'description' => '输入名称。', + 'type' => 'string', + 'example' => 'myinput', + ], + 'LanguageName' => [ + 'title' => '仅rtmp类型输入有效，表示output使用的Name标签', + 'description' => '语言名称。', + 'type' => 'string', + 'example' => 'eng', + ], + 'AudioSelectors' => [ + 'title' => '音频选择器列表', + 'description' => '音频选择器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myselector', + ], + 'AudioLanguageSelection' => [ + 'title' => '语言选择器', + 'description' => '语言选择器。', + 'type' => 'object', + 'properties' => [ + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码。3字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'eng', + ], + ], + ], + 'AudioPidSelection' => [ + 'title' => 'PID选择器', + 'description' => 'PID选择器。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'title' => 'PID', + 'description' => '输入源流的Pid。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'AudioTrackSelection' => [ + 'title' => '音轨选择器', + 'description' => 'track选择器。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrackId' => [ + 'title' => '音轨ID', + 'description' => '输入源流的TrackId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + ], + ], + ], + ], + ], + 'OutputGroups' => [ + 'title' => '输出组详细设置', + 'description' => '输出组配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Type' => [ + 'title' => '输出组类型', + 'description' => '输出组类型。', + 'type' => 'string', + 'example' => 'MediaPackage', + ], + 'Outputs' => [ + 'title' => '输出列表设置', + 'description' => '输出列表设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出名称', + 'description' => '输出名称。', + 'type' => 'string', + 'example' => 'output1', + ], + 'MediaType' => [ + 'title' => '输出的媒体类型', + 'description' => '输出的媒体类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MediaPackageOutputSetting' => [ + 'title' => '输出组类型为MediaPackage时的设置', + 'description' => '输出组类型为MediaPackage时的输出设置。', + 'type' => 'object', + 'properties' => [ + 'NameModifier' => [ + 'title' => 'manifest后缀', + 'description' => 'manifest后缀。', + 'type' => 'string', + 'example' => '480p', + ], + 'AudioGroupId' => [ + 'title' => 'manifest音频组id设置', + 'description' => 'manifest音频组id设置。', + 'type' => 'string', + 'example' => 'audiogroup', + ], + ], + ], + 'VideoSettingName' => [ + 'title' => '引用的视频设置名称', + 'description' => '引用的视频设置名称。', + 'type' => 'string', + 'example' => 'myVideo1', + ], + 'AudioSettingNames' => [ + 'title' => '引用的音频设置名称', + 'description' => '引用的音频设置名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的音频设置名称。', + 'type' => 'string', + 'example' => 'myAudio1', + ], + ], + ], + ], + ], + 'MediaPackageGroupSetting' => [ + 'title' => 'MediaPackage输出组设置', + 'description' => '输出组类型为MediaPackage时的输出组设置。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => 'MediaPackage的GroupName', + 'description' => '引用的MediaPackage的GroupName。', + 'type' => 'string', + 'example' => 'myPackageGroup', + ], + 'ChannelName' => [ + 'title' => 'MediaPackage的ChannelName', + 'description' => '引用的MediaPackage的ChannelName。', + 'type' => 'string', + 'example' => 'myPackageChannel', + ], + ], + ], + 'MonitorUrl' => [ + 'title' => '输出监看地址', + 'description' => '输出组监看地址，用于监播。仅当输出组类型为MediaPackage类型，查询频道详情时会返回输出组监看地址。', + 'type' => 'string', + 'example' => 'rtmp://xxx', + ], + ], + ], + ], + 'AudioSettings' => [ + 'title' => '音频设置', + 'description' => '音频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频设置名称', + 'description' => '音频设置名称。', + 'type' => 'string', + 'example' => 'zhuanfengzhuang', + ], + 'AudioSelectorName' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'example' => 'myselector', + ], + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码，3字符。', + 'type' => 'string', + 'example' => 'eng', + ], + 'LanguageName' => [ + 'title' => 'audio类型m3u8切片的名称', + 'description' => '语言名称。', + 'type' => 'string', + 'example' => 'English', + ], + 'AudioCodec' => [ + 'title' => '音频编码类型', + 'description' => '音频编码类型。', + 'type' => 'string', + 'example' => 'aac', + ], + 'AudioCodecSetting' => [ + 'title' => '音频编码设置', + 'description' => '音频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '音频编码级别', + 'description' => '音频编码级别。', + 'type' => 'string', + 'example' => 'AAC-LOW', + ], + 'Bitrate' => [ + 'title' => '音频比特率', + 'description' => '音频比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200000', + ], + 'SampleRate' => [ + 'title' => '音频采样率', + 'description' => '音频采样率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44100', + ], + ], + ], + ], + ], + ], + 'VideoSettings' => [ + 'title' => '视频设置', + 'description' => '视频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视频设置名称', + 'description' => '视频设置名称。', + 'type' => 'string', + 'example' => 'video1', + ], + 'Width' => [ + 'title' => '分辨率宽', + 'description' => '视频分辨率宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1280', + ], + 'Height' => [ + 'title' => '分辨率高', + 'description' => '视频分辨率高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '720', + ], + 'VideoCodec' => [ + 'title' => '视频编码类型', + 'description' => '视频编码类型。', + 'type' => 'string', + 'example' => 'H264', + ], + 'VideoCodecSetting' => [ + 'title' => '视频编码设置', + 'description' => '视频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'title' => '视频编码速率设置', + 'description' => '视频编码速率设置。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'title' => '视频比特率', + 'description' => '视频比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2500000', + ], + 'RateControlMode' => [ + 'title' => '视频编码码控规则', + 'description' => '视频编码码控规则。', + 'type' => 'string', + 'example' => 'ABR', + ], + 'MaxBitrate' => [ + 'title' => '视频编码最大比特率', + 'description' => '视频编码最大比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000000', + ], + 'BufferSize' => [ + 'title' => '视频编码缓冲区大小', + 'description' => '视频编码缓冲区大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000000', + ], + ], + ], + 'Framerate' => [ + 'title' => '视频帧率设置', + 'description' => '视频帧率设置。', + 'type' => 'object', + 'properties' => [ + 'FramerateControl' => [ + 'title' => '视频帧率设置模式', + 'description' => '视频帧率设置模式。', + 'type' => 'string', + 'example' => 'SPECIFIED', + ], + 'FramerateNumerator' => [ + 'title' => '视频帧率分子', + 'description' => '视频帧率分子。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'FramerateDenominator' => [ + 'title' => '视频帧率分母', + 'description' => '视频帧率分母。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Gop' => [ + 'title' => '视频GOP设置', + 'description' => '视频GOP设置。', + 'type' => 'object', + 'properties' => [ + 'GopSizeUnits' => [ + 'title' => '视频GOP长度单位', + 'description' => '视频GOP长度单位。', + 'type' => 'string', + 'example' => 'FRAMES', + ], + 'GopSize' => [ + 'title' => '视频GOP大小', + 'description' => '视频GOP大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'BframesNum' => [ + 'title' => 'B帧数', + 'description' => 'B帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'CodecDetail' => [ + 'title' => '视频编码详情设置', + 'description' => '视频编码详情设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '视频编码配置', + 'description' => '视频编码配置。', + 'type' => 'string', + 'example' => 'MAIN', + ], + 'Level' => [ + 'title' => '视频编码级别', + 'description' => '视频编码级别。暂不支持。', + 'type' => 'string', + 'example' => 'H264_LEVEL_AUTO', + ], + ], + ], + ], + ], + 'VideoCodecType' => [ + 'title' => '视频转码方式（普通转码、窄带高清转码等）', + 'description' => '视频转码方式（普通转码、窄带高清转码等）', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '频道创建时间', + 'description' => '频道创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'LastStartTime' => [ + 'title' => '频道上一次启动时间', + 'description' => '频道最近一次启动时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。'."\n" + .'如果频道创建后从未启动过，则返回空字符串。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'LastStopTime' => [ + 'title' => '频道上一次停止时间', + 'description' => '频道最近一次停止时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。'."\n" + .'如果频道创建后从未停止过，则返回空字符串。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Channel\\": {\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mych\\",\\n \\"State\\": \\"IDLE\\",\\n \\"InputAttachments\\": [\\n {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputName\\": \\"myinput\\",\\n \\"LanguageName\\": \\"eng\\",\\n \\"AudioSelectors\\": [\\n {\\n \\"Name\\": \\"myselector\\",\\n \\"AudioLanguageSelection\\": {\\n \\"LanguageCode\\": \\"eng\\"\\n },\\n \\"AudioPidSelection\\": {\\n \\"Pid\\": 123\\n },\\n \\"AudioTrackSelection\\": [\\n {\\n \\"TrackId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"group1\\",\\n \\"Type\\": \\"MediaPackage\\",\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output1\\",\\n \\"MediaType\\": 0,\\n \\"MediaPackageOutputSetting\\": {\\n \\"NameModifier\\": \\"480p\\",\\n \\"AudioGroupId\\": \\"audiogroup\\"\\n },\\n \\"VideoSettingName\\": \\"myVideo1\\",\\n \\"AudioSettingNames\\": [\\n \\"myAudio1\\"\\n ]\\n }\\n ],\\n \\"MediaPackageGroupSetting\\": {\\n \\"GroupName\\": \\"myPackageGroup\\",\\n \\"ChannelName\\": \\"myPackageChannel\\"\\n },\\n \\"MonitorUrl\\": \\"rtmp://xxx\\"\\n }\\n ],\\n \\"AudioSettings\\": [\\n {\\n \\"Name\\": \\"zhuanfengzhuang\\",\\n \\"AudioSelectorName\\": \\"myselector\\",\\n \\"LanguageCode\\": \\"eng\\",\\n \\"LanguageName\\": \\"English\\",\\n \\"AudioCodec\\": \\"aac\\",\\n \\"AudioCodecSetting\\": {\\n \\"Profile\\": \\"AAC-LOW\\",\\n \\"Bitrate\\": 200000,\\n \\"SampleRate\\": 44100\\n }\\n }\\n ],\\n \\"VideoSettings\\": [\\n {\\n \\"Name\\": \\"video1\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"H264\\",\\n \\"VideoCodecSetting\\": {\\n \\"Rate\\": {\\n \\"Bitrate\\": 2500000,\\n \\"RateControlMode\\": \\"ABR\\",\\n \\"MaxBitrate\\": 6000000,\\n \\"BufferSize\\": 6000000\\n },\\n \\"Framerate\\": {\\n \\"FramerateControl\\": \\"SPECIFIED\\",\\n \\"FramerateNumerator\\": 25,\\n \\"FramerateDenominator\\": 1\\n },\\n \\"Gop\\": {\\n \\"GopSizeUnits\\": \\"FRAMES\\",\\n \\"GopSize\\": 90,\\n \\"BframesNum\\": 3\\n },\\n \\"CodecDetail\\": {\\n \\"Profile\\": \\"MAIN\\",\\n \\"Level\\": \\"H264_LEVEL_AUTO\\"\\n }\\n },\\n \\"VideoCodecType\\": \\"NORMAL\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStartTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStopTime\\": \\"2024-12-03T06:56:42Z\\"\\n }\\n}","type":"json"}]', + 'title' => '查询媒体直播频道详情', + 'description' => '- 调用本接口查询媒体直播频道详情。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListMediaLiveChannels' => [ + 'summary' => '查询媒体直播频道列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为 100。'."\n" + .'默认值：'."\n" + .'- 当不设置值或设置的值小于 10 时，默认值为 10。'."\n" + .'- 当设置的值大于 100 时，默认值为 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Skip', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时跳过的条目数。'."\n" + .'当跳过的条目数超过符合条件的条目总数时，会返回空列表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次 API 调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定排序规则，用于按频道的创建时间排序。默认是asc。'."\n" + .'可选值：desc（降序排序），asc（升序排序）。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询的关键词。对频道ID/名称进行搜索，均支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'States', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询的频道状态，可以由多个频道状态组成一个 JSON 数组，状态值之间用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '["IDLE","RUNNING"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Channels' => [ + 'title' => '频道配置列表', + 'description' => '频道配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelId' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'Name' => [ + 'title' => '频道名称', + 'description' => '频道名称。', + 'type' => 'string', + 'example' => 'mych', + ], + 'State' => [ + 'title' => '频道状态', + 'description' => '频道状态。'."\n" + .'可能的返回值包括：IDLE（空闲中）, STARTING（启动中）, RUNNING（运行中）, RECOVERING（恢复中）， STOPPING（停止中）。', + 'type' => 'string', + 'example' => 'IDLE', + ], + 'InputAttachments' => [ + 'title' => '输入绑定设置', + 'description' => '输入绑定设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InputId' => [ + 'title' => '绑定的输入ID', + 'description' => '绑定的输入ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + 'InputName' => [ + 'title' => '输入名称', + 'description' => '输入名称。', + 'type' => 'string', + 'example' => 'myinput', + ], + 'LanguageName' => [ + 'title' => '仅rtmp类型输入有效，表示output使用的Name标签', + 'description' => '语言名称。', + 'type' => 'string', + 'example' => 'eng', + ], + 'AudioSelectors' => [ + 'title' => '音频选择器列表', + 'description' => '音频选择器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'myselector', + ], + 'AudioLanguageSelection' => [ + 'title' => '语言选择器', + 'description' => '语言选择器。', + 'type' => 'object', + 'properties' => [ + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码。3字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'eng', + ], + ], + ], + 'AudioPidSelection' => [ + 'title' => 'PID选择器', + 'description' => 'PID选择器。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'title' => 'PID', + 'description' => '输入源流的Pid。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'AudioTrackSelection' => [ + 'title' => '音轨选择器', + 'description' => 'track选择器。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TrackId' => [ + 'title' => '音轨ID', + 'description' => '输入源流的TrackId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + ], + ], + ], + ], + ], + 'OutputGroups' => [ + 'title' => '输出组详细设置', + 'description' => '输出组配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出组名称', + 'description' => '输出组名称。', + 'type' => 'string', + 'example' => 'group1', + ], + 'Type' => [ + 'title' => '输出组类型', + 'description' => '输出组类型。', + 'type' => 'string', + 'example' => 'MediaPackage', + ], + 'Outputs' => [ + 'title' => '输出列表设置', + 'description' => '输出列表设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '输出名称', + 'description' => '输出名称。', + 'type' => 'string', + 'example' => 'output1', + ], + 'MediaType' => [ + 'title' => '输出的媒体类型', + 'description' => '输出的媒体类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MediaPackageOutputSetting' => [ + 'title' => '输出组类型为MediaPackage时的设置', + 'description' => '输出组类型为MediaPackage时的输出设置。', + 'type' => 'object', + 'properties' => [ + 'NameModifier' => [ + 'title' => 'manifest后缀', + 'description' => 'manifest后缀。', + 'type' => 'string', + 'example' => '480p', + ], + 'AudioGroupId' => [ + 'title' => 'manifest音频组id设置', + 'description' => 'manifest音频组id设置。', + 'type' => 'string', + 'example' => 'audiogroup', + ], + ], + ], + 'VideoSettingName' => [ + 'title' => '引用的视频设置名称', + 'description' => '引用的视频设置名称。', + 'type' => 'string', + 'example' => 'myVideo1', + ], + 'AudioSettingNames' => [ + 'title' => '引用的音频设置名称', + 'description' => '引用的音频设置名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的音频设置名称。', + 'type' => 'string', + 'example' => 'myAudio1', + ], + ], + ], + ], + ], + 'MediaPackageGroupSetting' => [ + 'title' => 'MediaPackage输出组设置', + 'description' => '输出组类型为MediaPackage时的输出组设置。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'title' => 'MediaPackage的GroupName', + 'description' => '引用的MediaPackage的GroupName。', + 'type' => 'string', + 'example' => 'myPackageGroup', + ], + 'ChannelName' => [ + 'title' => 'MediaPackage的ChannelName', + 'description' => '引用的MediaPackage的ChannelName。', + 'type' => 'string', + 'example' => 'myPackageChannel', + ], + ], + ], + 'MonitorUrl' => [ + 'title' => '输出监看地址', + 'description' => '输出组监看地址，用于监播。仅当输出组类型为MediaPackage类型，查询频道详情时会返回输出组监看地址。', + 'type' => 'string', + 'example' => 'rtmp://xxx', + ], + ], + ], + ], + 'AudioSettings' => [ + 'title' => '音频设置', + 'description' => '音频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '音频设置名称', + 'description' => '音频设置名称。', + 'type' => 'string', + 'example' => 'zhuanfengzhuang', + ], + 'AudioSelectorName' => [ + 'title' => '音频选择器名称', + 'description' => '音频选择器名称。', + 'type' => 'string', + 'example' => 'myselector', + ], + 'LanguageCode' => [ + 'title' => '语言代码', + 'description' => 'ISO639-2语言代码，3字符。', + 'type' => 'string', + 'example' => 'eng', + ], + 'LanguageName' => [ + 'title' => 'audio类型m3u8切片的名称', + 'description' => '语言名称。', + 'type' => 'string', + 'example' => 'English', + ], + 'AudioCodec' => [ + 'title' => '音频编码类型', + 'description' => '音频编码类型。', + 'type' => 'string', + 'example' => 'aac', + ], + 'AudioCodecSetting' => [ + 'title' => '音频编码设置', + 'description' => '音频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '音频编码级别', + 'description' => '音频编码级别。', + 'type' => 'string', + 'example' => 'AAC-LOW', + ], + 'Bitrate' => [ + 'title' => '音频比特率', + 'description' => '音频比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200000', + ], + 'SampleRate' => [ + 'title' => '音频采样率', + 'description' => '音频采样率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44100', + ], + ], + ], + ], + ], + ], + 'VideoSettings' => [ + 'title' => '视频设置', + 'description' => '视频设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '视频设置名称', + 'description' => '视频设置名称。', + 'type' => 'string', + 'example' => 'video1', + ], + 'Width' => [ + 'title' => '分辨率宽', + 'description' => '视频分辨率宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1280', + ], + 'Height' => [ + 'title' => '分辨率高', + 'description' => '视频分辨率高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '720', + ], + 'VideoCodec' => [ + 'title' => '视频编码类型', + 'description' => '视频编码类型。', + 'type' => 'string', + 'example' => 'H264', + ], + 'VideoCodecSetting' => [ + 'title' => '视频编码设置', + 'description' => '视频编码设置。', + 'type' => 'object', + 'properties' => [ + 'Rate' => [ + 'title' => '视频编码速率设置', + 'description' => '视频编码速率设置。', + 'type' => 'object', + 'properties' => [ + 'Bitrate' => [ + 'title' => '视频比特率', + 'description' => '视频比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2500000', + ], + 'RateControlMode' => [ + 'title' => '视频编码码控规则', + 'description' => '视频编码码控规则。', + 'type' => 'string', + 'example' => 'ABR', + ], + 'MaxBitrate' => [ + 'title' => '视频编码最大比特率', + 'description' => '视频编码最大比特率。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000000', + ], + 'BufferSize' => [ + 'title' => '视频编码缓冲区大小', + 'description' => '视频编码缓冲区大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000000', + ], + ], + ], + 'Framerate' => [ + 'title' => '视频帧率设置', + 'description' => '视频帧率设置。', + 'type' => 'object', + 'properties' => [ + 'FramerateControl' => [ + 'title' => '视频帧率设置模式', + 'description' => '视频帧率设置模式。', + 'type' => 'string', + 'example' => 'SPECIFIED', + ], + 'FramerateNumerator' => [ + 'title' => '视频帧率分子', + 'description' => '视频帧率分子。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'FramerateDenominator' => [ + 'title' => '视频帧率分母', + 'description' => '视频帧率分母。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Gop' => [ + 'title' => '视频GOP设置', + 'description' => '视频GOP设置。', + 'type' => 'object', + 'properties' => [ + 'GopSizeUnits' => [ + 'title' => '视频GOP长度单位', + 'description' => '视频GOP长度单位。', + 'type' => 'string', + 'example' => 'FRAMES', + ], + 'GopSize' => [ + 'title' => '视频GOP大小', + 'description' => '视频GOP大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'BframesNum' => [ + 'title' => 'B帧数', + 'description' => 'B帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'CodecDetail' => [ + 'title' => '视频编码详情设置', + 'description' => '视频编码详情设置。', + 'type' => 'object', + 'properties' => [ + 'Profile' => [ + 'title' => '视频编码配置', + 'description' => '视频编码配置。', + 'type' => 'string', + 'example' => 'MAIN', + ], + 'Level' => [ + 'title' => '视频编码级别', + 'description' => '视频编码级别。暂不支持。', + 'type' => 'string', + 'example' => 'H264_LEVEL_AUTO', + ], + ], + ], + ], + ], + 'VideoCodecType' => [ + 'title' => '视频转码方式（普通转码、窄带高清转码等）', + 'description' => '视频转码方式（普通转码、窄带高清转码等）', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '频道创建时间', + 'description' => '频道创建时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'LastStartTime' => [ + 'title' => '频道上一次启动时间', + 'description' => '频道最近一次启动时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。'."\n" + .'如果频道创建后从未启动过，则返回空字符串。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + 'LastStopTime' => [ + 'title' => '频道上一次停止时间', + 'description' => '频道最近一次停止时间，格式为：yyyy-MM-ddTHH:mm:ssZ（RFC 3339格式），采用 UTC +0 时区。'."\n" + .'如果频道创建后从未停止过，则返回空字符串。', + 'type' => 'string', + 'example' => '2024-12-03T06:56:42Z', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => '查询凭证。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'TotalCount' => [ + 'description' => '符合分页条件查询的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Channels\\": [\\n {\\n \\"ChannelId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"Name\\": \\"mych\\",\\n \\"State\\": \\"IDLE\\",\\n \\"InputAttachments\\": [\\n {\\n \\"InputId\\": \\"SEGK5KA6KYKAWQQH\\",\\n \\"InputName\\": \\"myinput\\",\\n \\"LanguageName\\": \\"eng\\",\\n \\"AudioSelectors\\": [\\n {\\n \\"Name\\": \\"myselector\\",\\n \\"AudioLanguageSelection\\": {\\n \\"LanguageCode\\": \\"eng\\"\\n },\\n \\"AudioPidSelection\\": {\\n \\"Pid\\": 123\\n },\\n \\"AudioTrackSelection\\": [\\n {\\n \\"TrackId\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"Name\\": \\"group1\\",\\n \\"Type\\": \\"MediaPackage\\",\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"output1\\",\\n \\"MediaType\\": 0,\\n \\"MediaPackageOutputSetting\\": {\\n \\"NameModifier\\": \\"480p\\",\\n \\"AudioGroupId\\": \\"audiogroup\\"\\n },\\n \\"VideoSettingName\\": \\"myVideo1\\",\\n \\"AudioSettingNames\\": [\\n \\"myAudio1\\"\\n ]\\n }\\n ],\\n \\"MediaPackageGroupSetting\\": {\\n \\"GroupName\\": \\"myPackageGroup\\",\\n \\"ChannelName\\": \\"myPackageChannel\\"\\n },\\n \\"MonitorUrl\\": \\"rtmp://xxx\\"\\n }\\n ],\\n \\"AudioSettings\\": [\\n {\\n \\"Name\\": \\"zhuanfengzhuang\\",\\n \\"AudioSelectorName\\": \\"myselector\\",\\n \\"LanguageCode\\": \\"eng\\",\\n \\"LanguageName\\": \\"English\\",\\n \\"AudioCodec\\": \\"aac\\",\\n \\"AudioCodecSetting\\": {\\n \\"Profile\\": \\"AAC-LOW\\",\\n \\"Bitrate\\": 200000,\\n \\"SampleRate\\": 44100\\n }\\n }\\n ],\\n \\"VideoSettings\\": [\\n {\\n \\"Name\\": \\"video1\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"H264\\",\\n \\"VideoCodecSetting\\": {\\n \\"Rate\\": {\\n \\"Bitrate\\": 2500000,\\n \\"RateControlMode\\": \\"ABR\\",\\n \\"MaxBitrate\\": 6000000,\\n \\"BufferSize\\": 6000000\\n },\\n \\"Framerate\\": {\\n \\"FramerateControl\\": \\"SPECIFIED\\",\\n \\"FramerateNumerator\\": 25,\\n \\"FramerateDenominator\\": 1\\n },\\n \\"Gop\\": {\\n \\"GopSizeUnits\\": \\"FRAMES\\",\\n \\"GopSize\\": 90,\\n \\"BframesNum\\": 3\\n },\\n \\"CodecDetail\\": {\\n \\"Profile\\": \\"MAIN\\",\\n \\"Level\\": \\"H264_LEVEL_AUTO\\"\\n }\\n },\\n \\"VideoCodecType\\": \\"NORMAL\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStartTime\\": \\"2024-12-03T06:56:42Z\\",\\n \\"LastStopTime\\": \\"2024-12-03T06:56:42Z\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '查询媒体直播频道列表', + 'description' => '- 调用本接口查询媒体直播频道列表。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteMediaLiveChannel' => [ + 'summary' => '删除媒体直播频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除媒体直播频道', + 'description' => '- 调用本接口删除媒体直播频道。'."\n" + .'- 仅当媒体直播频道未启动时，允许删除频道，不允许删除正在运行的频道。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StartMediaLiveChannel' => [ + 'summary' => '启动媒体直播频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '启动媒体直播频道', + 'description' => '- 调用本接口启动媒体直播频道。'."\n" + .'- 仅当媒体直播频道未启动时，才能调用本接口启动频道，不能重复启动频道。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'StopMediaLiveChannel' => [ + 'summary' => '停止媒体直播频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道ID', + 'description' => '频道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'SEGK5KA6KYKAWQQH', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '停止媒体直播频道', + 'description' => '- 调用本接口停止媒体直播频道。'."\n" + .'- 仅当媒体直播频道启动后，才能调用本接口停止频道，不能停止未启动的频道。'."\n" + ."\n" + .'## QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SubmitMediaConvertJob' => [ + 'summary' => '提交媒体处理任务。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceEO4QPO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等性校验Key。保证请求幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => '86f8e525-9d73-4dac-88aa-7aa4e950c00a', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '转码任务配置，详情请参见[MediaConvertJobConfig](~~2999539~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "Inputs": [{'."\n" + .' "InputFile": {'."\n" + .' "Type": "OSS",'."\n" + .' "Url": "http://**.oss-cn-shanghai.aliyuncs.com/input/**/60min.mp4"'."\n" + .' }'."\n" + .' }],'."\n" + .' "Outputs": [{'."\n" + .' "OutputFile": {'."\n" + .' "Type": "OSS",'."\n" + .' "Url": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/360p.mp4"'."\n" + .' },'."\n" + .' "TemplateId": "S00000001-200000"'."\n" + .' }, {'."\n" + .' "OutputFile": {'."\n" + .' "Type": "OSS",'."\n" + .' "Url": "http://**.oss-cn-shanghai.aliyuncs.com/output/**/720p.mp4"'."\n" + .' },'."\n" + .' "TemplateId": "S00000001-200000"'."\n" + .' }]'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"videoId":"abcd"}', + ], + ], + [ + 'name' => 'PipelineId', + 'in' => 'query', + 'schema' => [ + 'description' => '管道ID 。', + 'type' => 'string', + 'required' => false, + 'example' => 'e197ecfb103e4849922b054d3032f954', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '提交媒体转码任务结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Job' => [ + 'title' => '转码作业', + 'description' => '媒体转码任务。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => 'A2129C9F-CE95-58B5-B8C1-07758FF6C86F', + ], + 'ClientToken' => [ + 'title' => '创建转码作业请求的幂等参数', + 'description' => '创建媒体转码任务请求的幂等参数', + 'type' => 'string', + 'example' => 'FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706', + ], + 'JobId' => [ + 'title' => '转码作业 ID', + 'description' => '媒体转码任务 ID。', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + 'Config' => [ + 'title' => '转码作业配置', + 'description' => '媒体转码任务配置。', + 'type' => 'object', + 'properties' => [ + 'Inputs' => [ + 'title' => '转码作业输入列表', + 'description' => '媒体转码任务输入列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输入', + 'description' => '媒体转码任务输入。', + 'example' => '[{\\"Src\\":{\\"Type\\":\\"MAP_SERVICE\\",\\"DataId\\":\\"479f6c63f66dcc1a9a09420fee32cbdf\\",\\"ZoomLevel\\":18},\\"Idx\\":1}]', + '$ref' => '#/components/schemas/MediaConvertInput', + ], + ], + 'Outputs' => [ + 'title' => '转码输出配置列表', + 'description' => '媒体转码输出配置列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输出配置', + 'description' => '媒体转码任务输出配置', + 'example' => '[]', + '$ref' => '#/components/schemas/MediaConvertOutput', + ], + ], + 'OutputGroups' => [ + 'title' => '转码输出组配置列表', + 'description' => '媒体转码任务输出组配置列表', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出组配置', + 'description' => '媒体转码任务输出组配置。', + '$ref' => '#/components/schemas/MediaConvertOutputGroup', + ], + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'Name', + ], + ], + ], + 'PipelineId' => [ + 'title' => '管道ID。', + 'description' => '管道ID。', + 'type' => 'string', + 'example' => '***48a4edf410b908aecd91fc3b***', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => '{"videoId":"abcd"}', + ], + 'Code' => [ + 'title' => '作业失败时错误码。执行成功时此参数不返回。', + 'description' => '媒体转码任务失败时错误码，执行失败时返回。', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad', + ], + 'Message' => [ + 'title' => '待添加的水印信息。', + 'description' => '媒体转码任务失败的详细信息，转码失败时返回。', + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'State' => [ + 'title' => '转码作业状态。'."\n" + .'● Inited : 初始化；'."\n" + .'● Running : 运行中；'."\n" + .'● Success : 转码成功；'."\n" + .'● Failed : 转码失败；'."\n" + .'● Cancelled : 已取消', + 'description' => '媒体转码任务状态：'."\n" + .'- Inited : 初始化；'."\n" + .'- Running : 运行中；'."\n" + .'- Success : 转码成功；'."\n" + .'- Failed : 转码失败；'."\n" + .'- Cancelled : 已取消。', + 'type' => 'string', + 'example' => 'Success', + ], + 'OutputDetails' => [ + 'title' => '转码输出结果列表', + 'description' => '媒体转码输出结果列表。', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出结果', + 'description' => '媒体转码输出结果。', + '$ref' => '#/components/schemas/MediaConvertOutputDetail', + ], + ], + 'OutputGroupDetails' => [ + 'title' => '转码输出组结果列表', + 'description' => '媒体转码输出组结果列表。', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出组结果', + 'description' => '媒体转码输出组结果。', + '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Job\\": {\\n \\"RequestId\\": \\"A2129C9F-CE95-58B5-B8C1-07758FF6C86F\\",\\n \\"ClientToken\\": \\"FB7F25E9-AD9B-1603-8AF6-F1E42DF2E706\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\",\\n \\"Config\\": {\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"JobName\\": \\"Name\\"\\n },\\n \\"PipelineId\\": \\"***48a4edf410b908aecd91fc3b***\\",\\n \\"UserData\\": \\"{\\\\\\"videoId\\\\\\":\\\\\\"abcd\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"State\\": \\"Success\\",\\n \\"OutputDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"OutputGroupDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Outputs\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '提交媒体转码任务', + ], + 'GetMediaConvertJob' => [ + 'summary' => '获取 MediaConvert 任务详情。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceEO4QPO', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '媒体转码任务 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '****d80e4e4044975745c14b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '查询转码作业返回结果', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402', + ], + 'Job' => [ + 'title' => '转码作业', + 'description' => '媒体转码任务。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '创建转码作业的请求ID', + 'description' => '创建媒体转码任务的请求 ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'ClientToken' => [ + 'title' => '创建转码作业请求的幂等参数', + 'description' => '创建媒体转码任务请求的幂等参数。', + 'type' => 'string', + 'example' => '780018cb-55ba-466d-8acc-946c0c319a0e ', + ], + 'JobId' => [ + 'title' => '转码作业 ID', + 'description' => '媒体转码任务 ID，32位字符串', + 'type' => 'string', + 'example' => '******4579b5e748b99a27f6d6******', + ], + 'Config' => [ + 'title' => '转码作业配置', + 'description' => '媒体转码任务配置。', + 'type' => 'object', + 'properties' => [ + 'Inputs' => [ + 'title' => '转码作业输入列表', + 'description' => '媒体转码任务输入列表。', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输入', + 'description' => '媒体转码任务输入。', + '$ref' => '#/components/schemas/MediaConvertInput', + ], + ], + 'Outputs' => [ + 'title' => '转码作业输出配置列表', + 'description' => '媒体转码任务输出配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输出配置', + 'description' => '媒体转码任务输出配置。', + '$ref' => '#/components/schemas/MediaConvertOutput', + ], + ], + 'OutputGroups' => [ + 'title' => '转码作业输出组列表', + 'description' => '媒体转码任务输出组配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '转码作业输出组配置', + 'description' => '媒体转码任务输出组配置。', + '$ref' => '#/components/schemas/MediaConvertOutputGroup', + ], + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'job-1-20241205-102045', + ], + ], + ], + 'PipelineId' => [ + 'title' => '管道ID', + 'description' => '管道 ID。', + 'type' => 'string', + 'example' => '83500cb2a3b94fabb0956e38d64bd16d', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据。', + 'type' => 'string', + 'example' => '{"videoId":"ddd333"}', + ], + 'Code' => [ + 'title' => '作业失败码', + 'description' => '媒体转码失败码。', + 'type' => 'string', + 'example' => 'InvalidParameter.ResourceContentBad', + ], + 'Message' => [ + 'title' => '作业失败详细信息', + 'description' => '媒体转码失败详细信息。', + 'type' => 'string', + 'example' => 'The resource operated InputFile is bad', + ], + 'State' => [ + 'title' => '转码作业状态。'."\n" + .'● Inited : 初始化；'."\n" + .'● Running : 运行中；'."\n" + .'● Success : 转码成功；'."\n" + .'● Failed : 转码失败；'."\n" + .'● Cancelled : 已取消'."\n", + 'description' => '媒体转码任务状态，值列表：'."\n" + .'- Inited : 初始化；'."\n" + .'- Running : 运行中；'."\n" + .'- Complete : 转码完成；'."\n" + .'- Error : 转码错误；'."\n" + .'- Cancelled : 已取消。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'OutputDetails' => [ + 'title' => '转码输出结果详情', + 'description' => '媒体转码输出结果详情列表，对应转码配置中转码输出列表的执行结果。', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出结果', + 'description' => '媒体转码输出结果。', + '$ref' => '#/components/schemas/MediaConvertOutputDetail', + ], + ], + 'OutputGroupDetails' => [ + 'title' => '转码输出组结果列表', + 'description' => '媒体转码输出组结果列表，对应转码配置中转码输出组列表的执行结果。', + 'type' => 'array', + 'items' => [ + 'title' => '转码输出组结果', + 'description' => '媒体转码输出组结果。', + '$ref' => '#/components/schemas/MediaConvertOutputGroupDetail', + ], + ], + 'Percent' => [ + 'description' => '任务完成百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T13:01:07Z'."\n", + ], + 'FinishTime' => [ + 'description' => '任务完成时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'example' => '2024-12-07T13:01:07Z'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BAEA8E8-1C16-5CD3-AC50-CCBA81A53402\\",\\n \\"Job\\": {\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"ClientToken\\": \\"780018cb-55ba-466d-8acc-946c0c319a0e \\",\\n \\"JobId\\": \\"******4579b5e748b99a27f6d6******\\",\\n \\"Config\\": {\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"JobName\\": \\"job-1-20241205-102045\\"\\n },\\n \\"PipelineId\\": \\"83500cb2a3b94fabb0956e38d64bd16d\\",\\n \\"UserData\\": \\"{\\\\\\"videoId\\\\\\":\\\\\\"ddd333\\\\\\"}\\",\\n \\"Code\\": \\"InvalidParameter.ResourceContentBad\\",\\n \\"Message\\": \\"The resource operated InputFile is bad\\",\\n \\"State\\": \\"Complete\\",\\n \\"OutputDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"OutputGroupDetails\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Outputs\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"TaskId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Result\\": {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"OutFileMeta\\": {\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Rotate\\": \\"0\\",\\n \\"Codec_tag\\": \\"0x001b\\",\\n \\"Sar\\": \\"478:477\\",\\n \\"Start_time\\": \\"1.473556\\",\\n \\"Fps\\": \\"25.0\\",\\n \\"Index\\": \\"0\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"Codec_long_name\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Bit_rate\\": \\"888.563\\",\\n \\"Profile\\": \\"High\\",\\n \\"Has_b_frames\\": \\"2\\",\\n \\"Codec_time_base\\": \\"\\",\\n \\"Dar\\": \\"16:9\\",\\n \\"Avg_fps\\": \\"25.0\\",\\n \\"Codec_tag_string\\": \\"[27][0][0][0]\\",\\n \\"Codec_name\\": \\"h264\\",\\n \\"Height\\": \\"478\\",\\n \\"Level\\": \\"31\\",\\n \\"Time_base\\": \\"1/90000\\",\\n \\"Width\\": \\"848\\",\\n \\"NumFrames\\": \\"10040\\"\\n }\\n ],\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"CodecTag\\": \\"0x000f\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"StartTime\\": \\"1.473556\\",\\n \\"Index\\": \\"1\\",\\n \\"Duration\\": \\"403.039989\\",\\n \\"Lang\\": \\"cn\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"Bitrate\\": \\"0.f\\",\\n \\"Channels\\": \\"2\\",\\n \\"Timebase\\": \\"1/90000\\",\\n \\"CodecTagString\\": \\"[15][0][0][0]\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\"\\n }\\n ],\\n \\"FileBasicInfo\\": {\\n \\"FileUrl\\": \\"http://bucket.oss-cn-shanghai.aliyuncs.com/path/to/file.m3u8\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"MediaId\\": \\"\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileName\\": \\"file.m3u8\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"hls,applehttp\\",\\n \\"Duration\\": \\"403.039999\\",\\n \\"Height\\": \\"478\\",\\n \\"Bitrate\\": \\"888.563\\",\\n \\"Width\\": \\"848\\",\\n \\"FileSize\\": \\"31737\\"\\n }\\n }\\n }\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Percent\\": 0,\\n \\"CreateTime\\": \\"2024-12-07T13:01:07Z\\\\n\\",\\n \\"FinishTime\\": \\"2024-12-07T13:01:07Z\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '查询媒体转码任务', + ], + 'ListMediaConvertJobs' => [ + 'summary' => '查询 MediaConvertJob 列表', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceHPAMBQ', + 'FEATUREice5MI8QL', + 'FEATUREiceCJ90B2', + 'FEATUREice6MQPM7', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '按 jobId 筛选。', + 'type' => 'string', + 'required' => false, + 'example' => '88c6ca184c0e47098a5b665e2****', + ], + ], + [ + 'name' => 'StartOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-01T00:00:00Z', + ], + ], + [ + 'name' => 'EndOfCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'description' => '任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-15T00:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态 - Init: 已提交, Success: 成功, Fail: 失败', + 'description' => '任务状态 '."\n" + .'- Inited: 已提交, '."\n" + .'- Running: 执行中'."\n" + .'- Complete: 完成, '."\n" + .'- Error: 错误。', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', + 'description' => '排序顺序。目前只支持两种：CreateTimeDesc: 按创建时间降序 和 CreateTimeAsc: 按创建时间升序', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTimeDesc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小。范围: 0~100，默认值：20。', + 'description' => '分页大小。范围: 0~100，默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => [ + 'title' => '连续分页查询时下一页的标记 (第一页没有)。', + 'description' => '连续分页查询时下一页的标记 (第一页没有)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ab4802364a2e49208c99efab82dfa8e8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'NextPageToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => '****cdb3e74639973036bc84****'."\n", + ], + 'Jobs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息（不包含Detail）。', + '$ref' => '#/components/schemas/MediaConvertJobWithoutDetail', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"NextPageToken\\": \\"****cdb3e74639973036bc84****\\\\n\\",\\n \\"Jobs\\": [\\n {\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"UserData\\": \\"\\",\\n \\"Config\\": {\\n \\"Outputs\\": [\\n {\\n \\"OutputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"JobName\\": \\"\\",\\n \\"OutputGroups\\": [\\n {\\n \\"GroupConfig\\": {\\n \\"OutputFileBase\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"ManifestName\\": \\"\\",\\n \\"Type\\": \\"\\"\\n },\\n \\"Outputs\\": [\\n {\\n \\"Priority\\": 0,\\n \\"OverrideParams\\": \\"\\",\\n \\"Features\\": \\"\\",\\n \\"OutputFileName\\": \\"\\",\\n \\"TemplateId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Inputs\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"InputFile\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\",\\n \\"Url\\": \\"\\"\\n }\\n }\\n ]\\n },\\n \\"State\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"PipelineId\\": \\"\\",\\n \\"ClientToken\\": \\"\\",\\n \\"TriggerSource\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"JobId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询媒体转码任务列表', + ], + 'GetMediaConnectAvailableRegion' => [ + 'summary' => '获取MediaConnect所有可用的区域', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '41CB9D4C-4650-5723-BA89-D6824F706ACB', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'RegionList' => [ + 'description' => '地域列表信息', + 'type' => 'array', + 'items' => [ + 'description' => '地域名', + 'type' => 'string', + 'example' => '[\'cn-shanghai\', \'cn-qingdao\']', + ], + ], + 'DefaultRegion' => [ + 'description' => '默认地域信息，可忽略', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41CB9D4C-4650-5723-BA89-D6824F706ACB\\",\\n \\"RetCode\\": 0,\\n \\"Description\\": \\"OK\\",\\n \\"Content\\": {\\n \\"RegionList\\": [\\n \\"[\'cn-shanghai\', \'cn-qingdao\']\\"\\n ],\\n \\"DefaultRegion\\": \\"cn-shanghai\\"\\n }\\n}","type":"json"}]', + 'title' => '获取MediaConnect所有可用的区域', + ], + 'ForbidMediaConnectFlowOutput' => [ + 'summary' => '禁用某个MediaConnect实例的某个输出，禁用后该输出配置仍保留，不再输出直播流信号。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFFXT3K', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => false, + 'example' => 'AliTestOutput', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1BCA0CFC-CBD4-5656-9D04-21B1FADBB92A\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '禁用MediaConnect实例的某个输出', + ], + 'ResumeMediaConnectFlowOutput' => [ + 'summary' => '恢复某个MediaConnect实例的某个输出，恢复后会正常输出直播信号。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFFXT3K', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => false, + 'example' => 'AliTestOutput', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '31E30781-9495-5E2D-A84D-759B0A01E262', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31E30781-9495-5E2D-A84D-759B0A01E262\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '恢复MediaConnect实例的某个输出', + ], + 'GetMediaConnectFlowAllOutputName' => [ + 'summary' => '获取某个MediaConnect实例下的所有output的名称。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'Content' => [ + 'description' => '响应体，类型为字符串数组', + 'type' => 'array', + 'items' => [ + 'description' => '输出名称', + 'type' => 'string', + 'example' => '[\'output1\',\'output2\']', + ], + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '559E9828-245D-5CBA-9C7A-4E01453F091F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"Content\\": [\\n \\"[\'output1\',\'output2\']\\"\\n ],\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"559E9828-245D-5CBA-9C7A-4E01453F091F\\"\\n}","type":"json"}]', + 'title' => '获取某个MediaConnect实例的所有输出名称', + ], + 'CloseMediaConnectFlowFailover' => [ + 'summary' => '关闭某个MediaConnect实例的双流灾备功能。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFFXT3K', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'MediaConnect实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '391DDF25-705C-5B38-9DB9-7A6B00D6065A', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，`0`表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"391DDF25-705C-5B38-9DB9-7A6B00D6065A\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '关闭MediaConnect输入双流灾备', + 'description' => '- 如果该实例有两个input，不能关闭双流灾备，需要先删除一个才能调用成功。', + ], + 'OpenMediaConnectFlowFailover' => [ + 'summary' => '对某个MediaConnect实例开启输入双流灾备。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFFXT3K', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'MediaConnect实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11357BE8-4C54-58EA-890A-5AB646EDE4B2\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '开启MediaConnect输入双流灾备', + 'description' => '- 需要先添加一个input，才能调用该接口开启双流灾备。'."\n" + ."\n" + .'- 开启后可以再添加一个input，两个input的输入类型需要保持一致。', + ], + 'UpdateMediaConnectFlowOutput' => [ + 'summary' => '修改某个MediaConnect Flow实例的某个output。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestOutput', + ], + ], + [ + 'name' => 'Cidrs', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单', + 'type' => 'string', + 'required' => false, + 'example' => '19.168.1.1/32,18.168.1.1/16', + ], + ], + [ + 'name' => 'SrtLatency', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT延迟，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SrtPassphrase', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密密钥，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => 'FICUBPX4Q77DYHRF', + ], + ], + [ + 'name' => 'SrtPbkeyLen', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密长度，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + ], + [ + 'name' => 'OutputToUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '输出地址，当输出类型是RTMP-PUSH/SRT-Caller模式时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', + ], + ], + [ + 'name' => 'PlayerLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '播放人数上限', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => 'Id of the request', + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D737D0BC-4CB5-55AA-8119-B540C95DFE6A', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D737D0BC-4CB5-55AA-8119-B540C95DFE6A\\"\\n}","type":"json"}]', + 'title' => '修改MediaConnect Flow实例的Output', + 'description' => '- 只有Flow实例状态为offline时才可以修改输出。'."\n" + .'- 无法修改输出类型。', + ], + 'GetMediaConnectFlowOutput' => [ + 'summary' => '根据outputName获取某个output的详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestOutput', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'OutputName' => [ + 'description' => '输出名称', + 'type' => 'string', + 'example' => 'AliTestInput', + ], + 'OutputProtocol' => [ + 'description' => '输出协议', + 'type' => 'string', + 'enumValueTitles' => [ + 'RTMP-PUSH' => 'RTMP-PUSH', + 'SRT-Caller' => 'SRT-Caller', + 'RTMP-PULL' => 'RTMP-PULL', + 'SRT-Listener' => 'SRT-Listener', + 'Flow' => 'Flow', + ], + 'example' => 'SRT-PULL', + ], + 'Cidrs' => [ + 'description' => 'IP白名单，CIDR格式，多个IP段之间用,分割', + 'type' => 'string', + 'example' => '10.211.0.0/17', + ], + 'OutputUrl' => [ + 'description' => '输出地址', + 'type' => 'string', + 'example' => 'srt://1.2.3.4:1025', + ], + 'SrtLatency' => [ + 'description' => 'SRT延迟，单位ms，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'SrtPassphrase' => [ + 'description' => 'SRT加密密钥，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'example' => 'FICUBPX4Q77DYHRF', + ], + 'SrtPbkeyLen' => [ + 'description' => 'SRT加密长度，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '0', + 16 => '16', + 24 => '24', + 32 => '32', + ], + 'example' => '32', + ], + 'PairFlowId' => [ + 'description' => '对端Flow实例ID，当输出类型为Flow时必填', + 'type' => 'string', + 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', + ], + 'PairInputName' => [ + 'description' => '对端Flow的输入名称，当输出类型为Flow时必填', + 'type' => 'string', + 'example' => 'AliTestInput', + ], + 'PlayerLimit' => [ + 'description' => '播放人数上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CreateTime' => [ + 'description' => 'Flow创建时间', + 'type' => 'string', + 'example' => '2024-07-18T01:29:24Z', + ], + 'Forbid' => [ + 'description' => '该输出是否处于禁用状态，取值为yes/no', + 'type' => 'string', + 'example' => 'no', + ], + ], + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0DB23DCE-0D69-598B-AA7C-7268D55E2F89', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"OutputName\\": \\"AliTestInput\\",\\n \\"OutputProtocol\\": \\"SRT-PULL\\",\\n \\"Cidrs\\": \\"10.211.0.0/17\\",\\n \\"OutputUrl\\": \\"srt://1.2.3.4:1025\\",\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"FICUBPX4Q77DYHRF\\",\\n \\"SrtPbkeyLen\\": 32,\\n \\"PairFlowId\\": \\"805fbdd0-575e-4146-b35d-ec7f63937b20\\",\\n \\"PairInputName\\": \\"AliTestInput\\",\\n \\"PlayerLimit\\": 5,\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"Forbid\\": \\"no\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"0DB23DCE-0D69-598B-AA7C-7268D55E2F89\\"\\n}","type":"json"}]', + 'title' => '获取MediaConnect Flow实例的Output信息', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。', + ], + 'DeleteMediaConnectFlowOutput' => [ + 'summary' => '删除某个MediaConnect Flow实例的某个output。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestOutput', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => 'Id of the request', + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'DF73E08E-F807-50F5-A2BD-B76391EAE8FF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"DF73E08E-F807-50F5-A2BD-B76391EAE8FF\\"\\n}","type":"json"}]', + 'title' => '删除MediaConnect Flow实例的Output', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 当Flow实例状态为online时，不能删除输出。', + ], + 'AddMediaConnectFlowOutput' => [ + 'summary' => '为MediaConnect Flow实例创建output。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f'."\n", + ], + ], + [ + 'name' => 'OutputProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '输出协议', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'RTMP-PUSH' => 'RTMP-PUSH', + 'SRT-Caller' => 'SRT-Caller', + 'RTMP-PULL' => 'RTMP-PULL', + 'SRT-Listener' => 'SRT-Listener', + 'Flow' => 'Flow', + ], + 'example' => 'RTMP-PULL', + ], + ], + [ + 'name' => 'OutputToUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '输出地址，当输出类型是RTMP-PUSH/SRT-Caller模式时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://push.test.alivecdn.com/live/alitest', + ], + ], + [ + 'name' => 'OutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输出名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestOutput', + ], + ], + [ + 'name' => 'Cidrs', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单，CIDR格式，多个IP段之间用,分割', + 'type' => 'string', + 'required' => false, + 'example' => '83.17.231.31/32', + ], + ], + [ + 'name' => 'PlayerLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '播放人数上限', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'PairInputName', + 'in' => 'query', + 'schema' => [ + 'description' => '对端Flow的输入名称，当输出类型为Flow时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'AliTestInput', + ], + ], + [ + 'name' => 'SrtLatency', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT延迟，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SrtPbkeyLen', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密长度，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + ], + [ + 'name' => 'SrtPassphrase', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密密钥，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'BETTERG08S01', + ], + ], + [ + 'name' => 'PairFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端Flow实例ID，当输出类型为Flow时必填', + 'type' => 'string', + 'required' => false, + 'example' => '8666ec062190f00e263012666319a5be', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'OutputUrl' => [ + 'description' => '输出地址', + 'type' => 'string', + 'example' => 'srt://1.2.3.4:1025', + ], + ], + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '11AA9E73-FBA0-58DC-97BA-D606D847BCB6', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"OutputUrl\\": \\"srt://1.2.3.4:1025\\"\\n },\\n \\"Description\\": \\"ok\\",\\n \\"RequestId\\": \\"11AA9E73-FBA0-58DC-97BA-D606D847BCB6\\",\\n \\"RetCode\\": 0\\n}","type":"json"}]', + 'title' => '为MediaConnect Flow实例创建Output', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 一个Flow实例最多有4个output。'."\n" + .'- 同一个Flow实例下的输出名称不能重复。'."\n" + .'- 您可以对每个output设置同时播放人数的上限，超过上限后新的播放将失败。每个output最多支持5路播放。'."\n" + .'### 输出类型描述'."\n" + .'- RTMP-PUSH：创建一个RTMP转推类型的输出，Flow会使用RTMP协议将直播流转推到您设置的源站上。'."\n" + .'- RTMP-PULL：创建一个RTMP监听类型的输出，您可以使用RTMP协议从接口返回的URL拉流。'."\n" + .'- SRT-Caller：创建一个SRT转推类型的输出，Flow会使用SRT协议将直播流转推到您设置的源站上。'."\n" + .'- SRT-Listener：创建一个SRT监听类型的输出，您可以使用SRT协议从接口返回的URL拉流。'."\n" + .'- Flow：以下游另一个Flow实例的输入作为输出，需要您同时指定对端Flow的实例ID和输入名称。下游Flow实例的输入类型必须为监听类型，即SRT-Listener/RTMP-PUSH，本实例会将直播流转推到下游Flow。Flow实例之间级联时默认走专线，可用于多个Flow之间的跨区域分发。', + ], + 'DeleteMediaConnectFlowInput' => [ + 'summary' => '删除某个MediaConnect实例的input。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + ], + ], + [ + 'name' => 'InputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输入名称，当实例开启输入主备时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'input', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C0C02296-113C-5838-8FE9-8F3A32998DDC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"C0C02296-113C-5838-8FE9-8F3A32998DDC\\"\\n}","type":"json"}]', + 'title' => '删除MediaConnect Flow实例的Input', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 当Flow实例状态为online时，不能删除输入。'."\n" + .'- 只有Flow实例下面的所有输出都删除后，才能删除输入。', + ], + 'UpdateMediaConnectFlowInput' => [ + 'summary' => '修改某个MediaConnect Flow实例的input。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'Cidrs', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单', + 'type' => 'string', + 'required' => false, + 'example' => '19.168.1.1/32,18.168.1.1/16', + ], + ], + [ + 'name' => 'SrtLatency', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT延迟，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SrtPassphrase', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密密钥，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => 'FICUBPX4Q77DYHRF', + ], + ], + [ + 'name' => 'SrtPbkeyLen', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密长度，当输入类型是SRT-Listener/SRT-Caller时可以修改', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '32', + ], + ], + [ + 'name' => 'InputFromUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '输入URL，当输入类型是RTMP-PULL/SRT-Listener时可以修改', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', + ], + ], + [ + 'name' => 'MaxBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '输入码率', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000000', + ], + ], + [ + 'name' => 'InputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输入名称，只有该实例开启输入主备时才需要填写', + 'type' => 'string', + 'required' => false, + 'example' => 'input1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '52451256-FFEA-5D2E-AA60-EE7053000F22', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"52451256-FFEA-5D2E-AA60-EE7053000F22\\"\\n}","type":"json"}]', + 'title' => '修改MediaConnect Flow实例的Input', + 'description' => '- 只有Flow实例状态为offline时才可以修改输入。'."\n" + .'- 无法修改输入类型。', + ], + 'GetMediaConnectFlowInput' => [ + 'summary' => '获取MediaConnect实例下的input信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'InputName' => [ + 'description' => '输入名称', + 'type' => 'string', + 'example' => 'AliTestInput', + ], + 'InputProtocol' => [ + 'description' => '输入类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'RTMP-PUSH' => 'RTMP-PUSH', + 'SRT-Caller' => 'SRT-Caller', + 'RTMP-PULL' => 'RTMP-PULL', + 'SRT-Listener' => 'SRT-Listener', + 'Flow' => 'Flow', + ], + 'example' => 'RTMP-PUSH', + ], + 'MaxBitrate' => [ + 'description' => '输入码率，单位bps', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000000', + ], + 'Cidrs' => [ + 'description' => 'IP白名单，CIDR格式，多个IP段之间用,分割', + 'type' => 'string', + 'example' => '10.211.0.0/17', + ], + 'InputUrl' => [ + 'description' => '输入URL', + 'type' => 'string', + 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', + ], + 'SrtLatency' => [ + 'description' => 'SRT延迟，单位ms，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'SrtPassphrase' => [ + 'description' => 'SRT加密密钥，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'example' => 'FICUBPX4Q77DYHRF', + ], + 'SrtPbkeyLen' => [ + 'description' => 'SRT加密长度，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '0', + 16 => '16', + 24 => '24', + 32 => '32', + ], + 'example' => '32', + ], + 'PairOutputName' => [ + 'description' => '对端Flow的输出名称，仅当输入类型是Flow时必填', + 'type' => 'string', + 'example' => 'AliTestOutput', + ], + 'PairFlowId' => [ + 'description' => '对端Flow实例ID，当输出类型为Flow时必填', + 'type' => 'string', + 'example' => '05c3adf4-aa0e-421d-a991-48ceae3e642e', + ], + 'CreateTime' => [ + 'description' => '输入创建时间', + 'type' => 'string', + 'example' => '2024-07-18T01:29:24Z', + ], + 'BackupInputName' => [ + 'description' => '备路输入名称', + 'type' => 'string', + ], + 'BackupCidrs' => [ + 'description' => '备路输入IP白名单', + 'type' => 'string', + ], + 'BackupInputUrl' => [ + 'description' => '备路输入URL', + 'type' => 'string', + ], + 'BackupSrtLatency' => [ + 'description' => '备路输入SRT延迟', + 'type' => 'integer', + 'format' => 'int32', + ], + 'BackupSrtPassphrase' => [ + 'description' => '备路输入SRT加密密钥', + 'type' => 'string', + ], + 'BackupSrtPbkeyLen' => [ + 'description' => '备路输入SRT加密长度', + 'type' => 'integer', + 'format' => 'int32', + ], + 'BackupCreateTime' => [ + 'description' => '备路输入创建时间', + 'type' => 'string', + ], + 'BackupMaxBitrate' => [ + 'description' => '备路输入码率', + 'type' => 'integer', + 'format' => 'int32', + ], + 'InputStatus' => [ + 'description' => '输入状态，标识主路是否推上来', + 'type' => 'string', + ], + 'BackupInputStatus' => [ + 'description' => '备路输入状态，标识备流是否推上来', + 'type' => 'string', + ], + ], + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D4C231DF-103A-55FF-8D09-E699552457DE', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"InputName\\": \\"AliTestInput\\",\\n \\"InputProtocol\\": \\"RTMP-PUSH\\",\\n \\"MaxBitrate\\": 2000000,\\n \\"Cidrs\\": \\"10.211.0.0/17\\",\\n \\"InputUrl\\": \\"rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be\\",\\n \\"SrtLatency\\": 1000,\\n \\"SrtPassphrase\\": \\"FICUBPX4Q77DYHRF\\",\\n \\"SrtPbkeyLen\\": 32,\\n \\"PairOutputName\\": \\"AliTestOutput\\",\\n \\"PairFlowId\\": \\"05c3adf4-aa0e-421d-a991-48ceae3e642e\\",\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"BackupInputName\\": \\"\\",\\n \\"BackupCidrs\\": \\"\\",\\n \\"BackupInputUrl\\": \\"\\",\\n \\"BackupSrtLatency\\": 0,\\n \\"BackupSrtPassphrase\\": \\"\\",\\n \\"BackupSrtPbkeyLen\\": 0,\\n \\"BackupCreateTime\\": \\"\\",\\n \\"BackupMaxBitrate\\": 0,\\n \\"InputStatus\\": \\"\\",\\n \\"BackupInputStatus\\": \\"\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"D4C231DF-103A-55FF-8D09-E699552457DE\\"\\n}","type":"json"}]', + 'title' => '获取MediaConnect Flow实例的Input信息', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。', + ], + 'AddMediaConnectFlowInput' => [ + 'summary' => '为MediaConnect Flow实例创建Input。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'InputProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '输入类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'RTMP-PUSH' => 'RTMP-PUSH', + 'SRT-Caller' => 'SRT-Caller', + 'RTMP-PULL' => 'RTMP-PULL', + 'SRT-Listener' => 'SRT-Listener', + 'Flow' => 'Flow', + ], + 'example' => 'RTMP-PUSH', + ], + ], + [ + 'name' => 'InputName', + 'in' => 'query', + 'schema' => [ + 'description' => '输入名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestInput', + ], + ], + [ + 'name' => 'MaxBitrate', + 'in' => 'query', + 'schema' => [ + 'description' => '输入码率，单位bps', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000000', + ], + ], + [ + 'name' => 'Cidrs', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP白名单，CIDR格式，多个IP段之间用,分割', + 'type' => 'string', + 'required' => false, + 'example' => '19.168.1.1/32,18.168.1.1/16', + ], + ], + [ + 'name' => 'InputFromUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '输入URL，仅当输入类型是RTMP-PULL/SRT-Listener时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp://pull.test.alivecdn.com/live/alitest', + ], + ], + [ + 'name' => 'PairFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '对端FlowId，仅当输入类型是Flow时必填', + 'type' => 'string', + 'required' => false, + 'example' => '805fbdd0-575e-4146-b35d-ec7f63937b20', + ], + ], + [ + 'name' => 'PairOutputName', + 'in' => 'query', + 'schema' => [ + 'description' => '对端Flow的输出名称，仅当输入类型是Flow时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'AliTestOutput', + ], + ], + [ + 'name' => 'SrtLatency', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT延迟，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SrtPassphrase', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密密钥，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'BETTERG08S01', + ], + ], + [ + 'name' => 'SrtPbkeyLen', + 'in' => 'query', + 'schema' => [ + 'description' => 'SRT加密长度，仅当输入类型是SRT-Listener/SRT-Caller时必填', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '0', + 16 => '16', + 24 => '24', + 32 => '32', + ], + 'example' => '32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'InputUrl' => [ + 'description' => '输入URL', + 'type' => 'string', + 'example' => 'rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be', + ], + ], + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '11357BE8-4C54-58EA-890A-5AB646EDE4B2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"InputUrl\\": \\"rtmp://1.2.3.4:1935/live/AliTestInput_8666ec062190f00e263012666319a5be\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"11357BE8-4C54-58EA-890A-5AB646EDE4B2\\"\\n}","type":"json"}]', + 'title' => '为MediaConnect Flow实例创建Input', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 默认情况下一个Flow只能有一个输入，开启双流灾备后可以再添加一个输入。'."\n" + .'### 输入类型描述'."\n" + .'- RTMP-PUSH：创建一个RTMP监听类型的输入，您可以用RTMP协议推到接口返回的URL上。'."\n" + .'- RTMP-PULL：创建一个RTMP回源拉流类型的输入，Flow会从您指定的源站拉回RTMP直播流。'."\n" + .'- SRT-Listener：创建一个SRT监听类型的输入，您可以用SRT协议推到接口返回的URL上。'."\n" + .'- SRT-Caller：创建一个SRT回源拉流类型的输入，Flow会从您指定的源站拉回SRT直播流。'."\n" + .'- Flow：以上游另一个Flow实例的输出作为输入，需要您同时指定对端Flow的实例ID和输出名称。上游Flow实例的输出必须为SRT-Listener/RTMP-PULL类型。Flow实例之间级联时默认走专线，可用于多个Flow之间的跨区域分发。', + ], + 'DeleteMediaConnectFlow' => [ + 'summary' => '根据实例ID删除MediaConnect实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '0381f478-7d53-4076-9d5f-27680a6f73e7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => 'Id of the request', + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，`0`表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5AEC17BD-D80B-5F78-BE1B-F07DFA0C8622', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"5AEC17BD-D80B-5F78-BE1B-F07DFA0C8622\\"\\n}","type":"json"}]', + 'title' => '删除MediaConnect Flow实例', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 删除Flow实例时，该Flow绑定的Input和Output都会被删除。'."\n" + .'- 不能删除online状态的Flow实例。', + ], + 'UpdateMediaConnectFlowStatus' => [ + 'summary' => '修改MediaConnect Flow实例的状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow状态：'."\n" + .'- online：开启Flow'."\n" + .'- offline：关闭Flow', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'offline' => 'offline', + 'online' => 'online', + ], + 'example' => 'online', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', + ], + 'Content' => [ + 'description' => '响应体', + 'type' => 'string', + 'example' => '""', + ], + 'Description' => [ + 'description' => '接口调用描述', + 'type' => 'string', + 'example' => 'ok', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Content\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Description\\": \\"ok\\",\\n \\"RetCode\\": 0\\n}","type":"json"}]', + 'title' => '修改MediaConnect Flow实例的状态', + ], + 'GetMediaConnectFlow' => [ + 'summary' => '根据实例ID获取对应MediaConnect Flow的详细信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + 'FlowName' => [ + 'description' => 'Flow实例名称', + 'type' => 'string', + 'example' => 'AliTestFlow', + ], + 'FlowStatus' => [ + 'description' => 'Flow状态', + 'type' => 'string', + 'example' => 'online', + ], + 'CreateTime' => [ + 'description' => 'Flow创建时间', + 'type' => 'string', + 'example' => '2024-07-18T01:29:24Z', + ], + 'StartTime' => [ + 'description' => 'Flow启动时间', + 'type' => 'string', + 'example' => '2024-07-18T01:39:24Z', + ], + 'FlowFailover' => [ + 'description' => 'Flow是否开启了输入双流灾备，取值为yes/no', + 'type' => 'string', + 'example' => 'yes', + ], + 'FlowRegion' => [ + 'type' => 'string', + ], + ], + ], + 'Description' => [ + 'description' => '接口调用描述信息', + 'type' => 'string', + 'example' => 'OK', + ], + 'Retcode' => [ + 'description' => '返回状态码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'FB503AEF-118E-1516-89E2-7B227EA1AC20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"FlowId\\": \\"34900dc6-90ec-4968-af3c-fcd87f231a5f\\",\\n \\"FlowName\\": \\"AliTestFlow\\",\\n \\"FlowStatus\\": \\"online\\",\\n \\"CreateTime\\": \\"2024-07-18T01:29:24Z\\",\\n \\"StartTime\\": \\"2024-07-18T01:39:24Z\\",\\n \\"FlowFailover\\": \\"yes\\",\\n \\"FlowRegion\\": \\"\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"Retcode\\": 0,\\n \\"RequestId\\": \\"FB503AEF-118E-1516-89E2-7B227EA1AC20\\"\\n}","type":"json"}]', + 'title' => '获取MediaConnect Flow实例的信息', + 'description' => '- 当输入的Flow实例ID不存在时，接口会返回错误。'."\n" + .'- 当Flow状态为online时，接口返回的StartTime才有效。', + ], + 'CreateMediaConnectFlow' => [ + 'summary' => '创建一个MediaConnect Flow实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'AliTestFlow', + ], + ], + [ + 'name' => 'FlowRegion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow实例所属region', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow实例ID', + 'type' => 'string', + 'example' => '34900dc6-90ec-4968-af3c-fcd87f231a5f', + ], + ], + ], + 'Description' => [ + 'description' => '接口返回描述信息', + 'type' => 'string', + 'example' => 'OK', + ], + 'RetCode' => [ + 'description' => '返回的错误码，0表示成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '86D92F9D-65E8-58A2-85D1-9DEEECC172E8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": {\\n \\"FlowId\\": \\"34900dc6-90ec-4968-af3c-fcd87f231a5f\\"\\n },\\n \\"Description\\": \\"OK\\",\\n \\"RetCode\\": 0,\\n \\"RequestId\\": \\"86D92F9D-65E8-58A2-85D1-9DEEECC172E8\\"\\n}","type":"json"}]', + 'title' => '创建MediaConnect Flow实例', + 'description' => '- 同一个区域下Flow的名称不能重复。'."\n" + .'- 接口正常响应时会返回Flow实例ID，请您妥善保存。', + ], + 'AddAdInsertion' => [ + 'summary' => '添加广告插入配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => [ + 'FEATUREiceN57D5I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '配置名称，同个账号下有唯一性，最长支持128个字符，支持字符：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'my_ad', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数，每次提交确保唯一性，避免重复提交表单，最长支持200个字符', + 'type' => 'string', + 'required' => false, + 'example' => '****0311a423d11a5f7dee713535****', + ], + ], + [ + 'name' => 'ContentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'https://source.com/', + ], + ], + [ + 'name' => 'SlateAdUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL，支持http/https协议，只支持MP4类型文件(.mp4)，最长支持2048个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://storage.com/slate1.mp4', + ], + ], + [ + 'name' => 'ConfigAliases', + 'in' => 'formData', + 'schema' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名，json字符串，其中player_params.{name}最多添加20个，name部分限制150个字符长度，每个player_params.xxx下最多添加50对key-value，key限制150个字符长度，value限制500个字符长度，例：'."\n" + .'{'."\n" + .' "player_params.{name}": {'."\n" + .' "{key}": "{value}"'."\n" + .' }'."\n" + .'}', + 'type' => 'string', + 'required' => false, + 'example' => '{ "player_params.p1": { "1": "abc" } }', + ], + ], + [ + 'name' => 'CdnContentSegmentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://cdn.com/', + ], + ], + [ + 'name' => 'CdnAdSegmentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://cdn.com/', + ], + ], + [ + 'name' => 'AdMarkerPassthrough', + 'in' => 'formData', + 'schema' => [ + 'title' => '内容URL前缀', + 'description' => '广告标记透传，ON/OFF，默认OFF', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFF' => '关闭', + 'ON' => '开启', + ], + 'example' => 'ON', + ], + ], + [ + 'name' => 'PersonalizationThreshold', + 'in' => 'formData', + 'schema' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值，单位秒，不填默认8秒', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'AdsUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL，支持http/https协议，最长支持2048个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '广告插入配置', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z'."\n", + ], + 'Name' => [ + 'title' => '广告插入配置名称', + 'description' => '广告插入配置名称', + 'type' => 'string', + 'example' => 'my_ad', + ], + 'ContentUrlPrefix' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀', + 'type' => 'string', + 'example' => 'https://source.com/'."\n", + ], + 'AdsUrl' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL', + 'type' => 'string', + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'."\n", + ], + 'ConfigAliases' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名', + 'type' => 'string', + 'example' => '{ "player_params.p1": { "1": "abc" } }'."\n", + ], + 'PersonalizationThreshold' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlateAdUrl' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL', + 'type' => 'string', + 'example' => 'http://storage.com/slate1.mp4'."\n", + ], + 'CdnConfig' => [ + 'title' => 'CDN配置', + 'description' => 'CDN配置', + 'type' => 'object', + 'properties' => [ + 'ContentSegmentUrlPrefix' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/'."\n", + ], + 'AdSegmentUrlPrefix' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/'."\n", + ], + ], + ], + 'AdMarkerPassthrough' => [ + 'title' => '广告标记透传', + 'description' => '广告标记透传', + 'type' => 'string', + 'example' => 'ON', + ], + 'ManifestEndpointConfig' => [ + 'title' => '清单播放端点配置', + 'description' => '清单播放端点配置', + 'type' => 'object', + 'properties' => [ + 'HlsPrefix' => [ + 'title' => 'HLS清单播放端点前缀', + 'description' => 'HLS清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/'."\n", + ], + 'DashPrefix' => [ + 'title' => 'DASH清单播放端点前缀', + 'description' => 'DASH清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\n\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\\\n\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\\\n\\",\\n \\"ConfigAliases\\": \\"{ \\\\\\"player_params.p1\\\\\\": { \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\" } }\\\\n\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\\\n\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\\\n\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\\\n\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\\\n\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '添加广告插入配置', + ], + 'UpdateAdInsertion' => [ + 'summary' => '更新广告插入配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => [ + 'FEATUREiceN57D5I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '配置名称，不可修改', + 'type' => 'string', + 'required' => true, + 'example' => 'my_ad', + ], + ], + [ + 'name' => 'ContentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'https://source.com/', + ], + ], + [ + 'name' => 'SlateAdUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL，支持http/https协议，只支持MP4类型文件(.mp4)，最长支持2048个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://storage.com/slate1.mp4', + ], + ], + [ + 'name' => 'ConfigAliases', + 'in' => 'formData', + 'schema' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名，json字符串，其中player_params.{name}最多添加20个，name部分限制150个字符长度，每个player_params.xxx下最多添加50对key-value，key限制150个字符长度，value限制500个字符长度，例： { "player_params.{name}": { "{key}": "{value}" } }', + 'type' => 'string', + 'required' => false, + 'example' => '{ "player_params.p1": { "1": "abc" } }', + ], + ], + [ + 'name' => 'CdnContentSegmentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://cdn.com/', + ], + ], + [ + 'name' => 'CdnAdSegmentUrlPrefix', + 'in' => 'formData', + 'schema' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀，支持http/https协议，最长支持512个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'http://cdn.com/', + ], + ], + [ + 'name' => 'AdMarkerPassthrough', + 'in' => 'formData', + 'schema' => [ + 'title' => '内容URL前缀', + 'description' => '广告标记透传，ON/OFF，默认OFF', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFF' => '关闭', + 'ON' => '开启', + ], + 'example' => 'ON', + ], + ], + [ + 'name' => 'PersonalizationThreshold', + 'in' => 'formData', + 'schema' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值，单位秒，不填默认8秒', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'AdsUrl', + 'in' => 'formData', + 'schema' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL，支持http/https协议，最长支持2048个字符', + 'type' => 'string', + 'required' => true, + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '广告插入配置', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z', + ], + 'Name' => [ + 'title' => '广告插入配置名称', + 'description' => '广告插入配置名称', + 'type' => 'string', + 'example' => 'my_ad', + ], + 'ContentUrlPrefix' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀', + 'type' => 'string', + 'example' => 'https://source.com/', + ], + 'AdsUrl' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL', + 'type' => 'string', + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', + ], + 'ConfigAliases' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名', + 'type' => 'string', + 'example' => '{ "player_params.p1": { "1": "abc" } }'."\n", + ], + 'PersonalizationThreshold' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlateAdUrl' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL', + 'type' => 'string', + 'example' => 'http://storage.com/slate1.mp4', + ], + 'CdnConfig' => [ + 'title' => 'CDN配置', + 'description' => 'CDN配置', + 'type' => 'object', + 'properties' => [ + 'ContentSegmentUrlPrefix' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + 'AdSegmentUrlPrefix' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + ], + ], + 'AdMarkerPassthrough' => [ + 'title' => '广告标记透传', + 'description' => '广告标记透传', + 'type' => 'string', + 'example' => 'ON', + ], + 'ManifestEndpointConfig' => [ + 'title' => '清单播放端点配置', + 'description' => '清单播放端点配置', + 'type' => 'object', + 'properties' => [ + 'HlsPrefix' => [ + 'title' => 'HLS清单播放端点前缀', + 'description' => 'HLS清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + 'DashPrefix' => [ + 'title' => 'DASH清单播放端点前缀', + 'description' => 'DASH清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****63E8B7C7-4812-46AD-0FA56029AC86****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{ \\\\\\"player_params.p1\\\\\\": { \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\" } }\\\\n\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n },\\n \\"RequestId\\": \\"****63E8B7C7-4812-46AD-0FA56029AC86****\\"\\n}","type":"json"}]', + 'title' => '更新广告插入配置', + ], + 'GetAdInsertion' => [ + 'summary' => '获取广告插入配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => [ + 'FEATUREiceN57D5I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '配置名称，精确匹配查找', + 'type' => 'string', + 'required' => true, + 'example' => 'my_ad', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '广告插入配置', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z ', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z ', + ], + 'Name' => [ + 'title' => '广告插入配置名称', + 'description' => '广告插入配置名称', + 'type' => 'string', + 'example' => 'my_ad', + ], + 'ContentUrlPrefix' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀', + 'type' => 'string', + 'example' => 'https://source.com/'."\n", + ], + 'AdsUrl' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL', + 'type' => 'string', + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', + ], + 'ConfigAliases' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名', + 'type' => 'string', + 'example' => '{'."\n" + .' "player_params.p1": {'."\n" + .' "1": "abc"'."\n" + .' }'."\n" + .'}', + ], + 'PersonalizationThreshold' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlateAdUrl' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL', + 'type' => 'string', + 'example' => 'http://storage.com/slate1.mp4', + ], + 'CdnConfig' => [ + 'title' => 'CDN配置', + 'description' => 'CDN配置', + 'type' => 'object', + 'properties' => [ + 'ContentSegmentUrlPrefix' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + 'AdSegmentUrlPrefix' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + ], + ], + 'AdMarkerPassthrough' => [ + 'title' => '广告标记透传', + 'description' => '广告标记透传', + 'type' => 'string', + 'example' => 'ON', + ], + 'ManifestEndpointConfig' => [ + 'title' => '清单播放端点配置', + 'description' => '清单播放端点配置', + 'type' => 'object', + 'properties' => [ + 'HlsPrefix' => [ + 'title' => 'HLS清单播放端点前缀', + 'description' => 'HLS清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + 'DashPrefix' => [ + 'title' => 'DASH清单播放端点前缀', + 'description' => 'DASH清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\\\t\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\t\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\\\n\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{\\\\n \\\\\\"player_params.p1\\\\\\": {\\\\n \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\"\\\\n }\\\\n}\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '获取广告插入配置', + ], + 'ListAdInsertions' => [ + 'summary' => '获取广告插入配置列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238120', + 'abilityTreeNodes' => [ + 'FEATUREiceN57D5I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '按广告名称查询，支持模糊匹配', + 'description' => '按广告配置名称查询，支持模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'ad', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码', + 'description' => '分页参数，页码，默认为1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页宽', + 'description' => '分页参数，页宽，默认为10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', + 'description' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => '按创建时间升序', + 'desc' => '按创建时间降序', + ], + 'example' => 'asc', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', + 'description' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', + 'type' => 'string', + 'required' => false, + 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效', + 'description' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效，默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '0', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'title' => '数组', + 'description' => '数组', + 'type' => 'array', + 'items' => [ + 'title' => 'AdInsertionConifgItemType', + 'description' => 'AdInsertionConifgItemType', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-06-13T08:26:09Z'."\n", + ], + 'Name' => [ + 'title' => '广告插入配置名称', + 'description' => '广告插入配置名称', + 'type' => 'string', + 'example' => 'my_ad', + ], + 'ContentUrlPrefix' => [ + 'title' => '内容URL前缀', + 'description' => '内容URL前缀', + 'type' => 'string', + 'example' => 'https://source.com/', + ], + 'AdsUrl' => [ + 'title' => '广告策略服务器URL', + 'description' => '广告策略服务器URL', + 'type' => 'string', + 'example' => 'http://ads.com/ad1?param1=[palyer_params.p1]', + ], + 'ConfigAliases' => [ + 'title' => '动态配置别名', + 'description' => '动态配置别名', + 'type' => 'string', + 'example' => '{'."\n" + .' "player_params.p1": {'."\n" + .' "1": "abc"'."\n" + .' }'."\n" + .'}', + ], + 'PersonalizationThreshold' => [ + 'title' => '个性化配置阈值', + 'description' => '个性化配置阈值', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SlateAdUrl' => [ + 'title' => 'slate广告URL', + 'description' => 'slate广告URL', + 'type' => 'string', + 'example' => 'http://storage.com/slate1.mp4', + ], + 'CdnConfig' => [ + 'title' => 'CDN配置', + 'description' => 'CDN配置', + 'type' => 'object', + 'properties' => [ + 'ContentSegmentUrlPrefix' => [ + 'title' => '视频内容分片的CDN前缀', + 'description' => '视频内容分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + 'AdSegmentUrlPrefix' => [ + 'title' => '广告分片的CDN前缀', + 'description' => '广告分片的CDN前缀', + 'type' => 'string', + 'example' => 'http://cdn.com/', + ], + ], + ], + 'AdMarkerPassthrough' => [ + 'title' => '广告标记透传', + 'description' => '广告标记透传', + 'type' => 'string', + 'example' => 'ON', + ], + 'ManifestEndpointConfig' => [ + 'title' => '清单播放端点配置', + 'description' => '清单播放端点配置', + 'type' => 'object', + 'properties' => [ + 'HlsPrefix' => [ + 'title' => 'HLS清单播放端点前缀', + 'description' => 'HLS清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + 'DashPrefix' => [ + 'title' => 'DASH清单播放端点前缀', + 'description' => 'DASH清单播放端点前缀', + 'type' => 'string', + 'example' => 'https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/', + ], + ], + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '分页参数，页码', + 'description' => '分页参数，页码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页参数，页宽', + 'description' => '分页参数，页宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SortBy' => [ + 'title' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', + 'description' => '分页参数，排序方式，asc:按创建时间升序，desc:按创建时间降序', + 'type' => 'string', + 'example' => 'asc', + ], + 'TotalCount' => [ + 'title' => '总记录数', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NextToken' => [ + 'title' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', + 'description' => '数据抓取参数，获取后续数据的token，使用此方式获取数据时分页参数将无效', + 'type' => 'string', + 'example' => '******8EqYpQbZ6Eh7+Zz8DxVYoQ*****', + ], + 'MaxResults' => [ + 'title' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效', + 'description' => '数据抓取参数，获取后续数据的最大记录数，使用此方式获取数据时分页参数将无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Configs\\": [\\n {\\n \\"CreateTime\\": \\"2024-06-13T08:26:09Z\\",\\n \\"LastModified\\": \\"2024-06-13T08:26:09Z\\\\n\\",\\n \\"Name\\": \\"my_ad\\",\\n \\"ContentUrlPrefix\\": \\"https://source.com/\\",\\n \\"AdsUrl\\": \\"http://ads.com/ad1?param1=[palyer_params.p1]\\",\\n \\"ConfigAliases\\": \\"{\\\\n \\\\\\"player_params.p1\\\\\\": {\\\\n \\\\\\"1\\\\\\": \\\\\\"abc\\\\\\"\\\\n }\\\\n}\\",\\n \\"PersonalizationThreshold\\": 5,\\n \\"SlateAdUrl\\": \\"http://storage.com/slate1.mp4\\",\\n \\"CdnConfig\\": {\\n \\"ContentSegmentUrlPrefix\\": \\"http://cdn.com/\\",\\n \\"AdSegmentUrlPrefix\\": \\"http://cdn.com/\\"\\n },\\n \\"AdMarkerPassthrough\\": \\"ON\\",\\n \\"ManifestEndpointConfig\\": {\\n \\"HlsPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\",\\n \\"DashPrefix\\": \\"https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\\"\\n }\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"asc\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"******8EqYpQbZ6Eh7+Zz8DxVYoQ*****\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + 'title' => '获取广告插入配置列表', + ], + 'DeleteAdInsertion' => [ + 'summary' => '删除广告插入配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => [ + 'FEATUREiceN57D5I', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '配置名称，精确匹配查找', + 'type' => 'string', + 'required' => true, + 'example' => 'my_ad', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除广告插入配置', + ], + 'GetSourceLocation' => [ + 'summary' => '获取源位置。', + 'description' => '调用GetSourceLocation接口获取源位置信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'SourceLocation' => [ + 'description' => '源位置信息', + '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取频道组装源位置信息', + ], + 'UpdateSourceLocation' => [ + 'summary' => '更新源位置。', + 'description' => '调用UpdateSourceLocation接口更新源位置。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'BaseUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置Url。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxx.com', + ], + ], + [ + 'name' => 'EnableSegmentDelivery', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用独立域名访问切片文件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SegmentDeliveryUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '切片文件传输Url。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxx.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'SourceLocation' => [ + 'description' => '源位置信息', + '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新频道组装源位置', + ], + 'DeleteSourceLocation' => [ + 'summary' => '删除源位置。', + 'description' => '调用DeleteSourceLocation接口删除源位置。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'SoftDelete', + 'in' => 'query', + 'schema' => [ + 'description' => '逻辑删除标记。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除频道组装源位置', + ], + 'ListSourceLocations' => [ + 'summary' => '列举源位置。', + 'description' => '调用ListSourceLocations接口列举源位置。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'FilterState', + 'in' => 'query', + 'schema' => [ + 'description' => '是否过滤删除状态。true表示只返回不为删除状态的源位置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '- 分页页码'."\n" + .'- 默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortByModifiedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按修改时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNo' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页数据个数，默认为20，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SourceLocationList' => [ + 'description' => '源位置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源位置信息。', + '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"SourceLocationList\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举频道组装源位置', + ], + 'CreateSourceLocation' => [ + 'summary' => '创建一个新的源位置。', + 'description' => '调用接口创建一个源位置。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourcelocation', + ], + ], + [ + 'name' => 'BaseUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置信息，包含协议头和host', + 'type' => 'string', + 'required' => true, + 'example' => 'http://xxx.com', + ], + ], + [ + 'name' => 'EnableSegmentDelivery', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用独立的域名访问分片文件', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SegmentDeliveryUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '分片使用的host信息', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxxx.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'SourceLocation' => [ + 'description' => '源位置信息', + '$ref' => '#/components/schemas/ChannelAssemblySourceLocation', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"SourceLocation\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"SegmentDeliveryConfigurations\\": \\"\\",\\n \\"BaseUrl\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '创建频道组装源位置', + ], + 'UpdateProgram' => [ + 'summary' => '更新节目。', + 'description' => '调用UpdateProgram接口创建节目。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'program1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'ClipRange', + 'in' => 'query', + 'schema' => [ + 'description' => '片段信息。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', + ], + ], + [ + 'name' => 'AdBreaks', + 'in' => 'query', + 'schema' => [ + 'description' => '广告信息。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"MessageType":"SPLICE_INSERT","OffsetMillis":1000,"SourceLocationName":"MySourceLocation","SourceName":"MyAdSource","SpliceInsertSettings":{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}}]', + ], + ], + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySourceLcation', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MySource', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '节目的源类型。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'Transition', + 'in' => 'query', + 'schema' => [ + 'description' => '节目转换信息。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Program' => [ + 'description' => '节目信息。', + '$ref' => '#/components/schemas/ChannelAssemblyProgram', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新频道组装节目', + ], + 'GetProgram' => [ + 'summary' => '获取节目。', + 'description' => '调用GetProgram接口获取节目信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'program1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Program' => [ + 'description' => '节目信息。', + '$ref' => '#/components/schemas/ChannelAssemblyProgram', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取频道组装节目', + ], + 'DeleteChannel' => [ + 'summary' => '删除频道。', + 'description' => '调用DeleteChannel接口删除频道。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除频道组装频道', + ], + 'UpdateSource' => [ + 'summary' => '更新源。', + 'description' => '调用UpdateSource接口更新源信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourcelocation', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySource', + ], + ], + [ + 'name' => 'HttpPackageConfigurations', + 'in' => 'query', + 'schema' => [ + 'description' => '源配置。', + 'type' => 'string', + 'required' => true, + 'example' => '[{'."\n" + .' "sourceGroupName": "mySourceGroup-1",'."\n" + .' "relativePath": "group1/hls.m3u8",'."\n" + .' "packageType": "hls"'."\n" + .'}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Source' => [ + 'description' => '源信息。', + '$ref' => '#/components/schemas/ChannelAssemblySource', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '更新频道组装源信息', + ], + 'StartChannel' => [ + 'summary' => '启动频道。', + 'description' => '调用StartChannel接口启动频道。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '开启频道组装频道', + ], + 'DeleteProgram' => [ + 'summary' => '删除节目。', + 'description' => '调用DeleteProgram接口删除节目。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'program_name', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除频道组装节目', + ], + 'DeleteSource' => [ + 'summary' => '删除源。', + 'description' => '调用DeleteSource接口删除源。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型：vodSource，liveSource', + 'type' => 'string', + 'required' => true, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyVodSource', + ], + ], + [ + 'name' => 'SoftDelete', + 'in' => 'query', + 'schema' => [ + 'description' => '逻辑删除标记。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除频道组装源', + ], + 'StopChannel' => [ + 'summary' => '停止频道。', + 'description' => '调用StopChannel接口停止频道。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Success' => [ + 'description' => '是否请求成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '停止频道组装频道', + ], + 'ListChannels' => [ + 'summary' => '获取频道列表。', + 'description' => '调用ListChannels接口列举频道组装频道列表。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'ChannelTier', + 'in' => 'query', + 'schema' => [ + 'description' => '频道等级。', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + ], + [ + 'name' => 'PlaybackMode', + 'in' => 'query', + 'schema' => [ + 'description' => '播放模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'loop', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '频道状态，0，停止；1，开启。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortByModifiedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按修改时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '创建时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '频道数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'PageSize' => [ + 'description' => '每页大小，[1, 100]，不传默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ChannelList' => [ + 'description' => '频道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '频道信息。', + '$ref' => '#/components/schemas/ChannelAssemblyChannel', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 180,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"ChannelList\\": [\\n {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举频道组装频道', + ], + 'ListPrograms' => [ + 'summary' => '获取节目列表。', + 'description' => '调用ListPrograms接口列举节目。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'program1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序，按CreateTime排序，默认是desc。'."\n" + ."\n" + .'- asc - 正序'."\n" + .'- desc - 倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '符合要求的节目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Programs' => [ + 'description' => '节目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节目信息。', + '$ref' => '#/components/schemas/ChannelAssemblyProgram', + ], + ], + 'PageNo' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页数据个数，默认为20，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"Programs\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '列举频道组装节目', + ], + 'GetSource' => [ + 'summary' => '获取源。', + 'description' => '调用GetSource接口获取源信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型，vodSource,liveSource。', + 'type' => 'string', + 'required' => true, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyVodSource', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Source' => [ + 'description' => '源信息。', + '$ref' => '#/components/schemas/ChannelAssemblySource', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取频道组装源信息', + ], + 'CreateChannel' => [ + 'summary' => '创建一个新的频道。', + 'description' => '调用CreateChannel接口创建频道。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'ChannelTier', + 'in' => 'query', + 'schema' => [ + 'description' => '频道等级。', + 'type' => 'string', + 'required' => true, + 'example' => 'basic', + ], + ], + [ + 'name' => 'PlaybackMode', + 'in' => 'query', + 'schema' => [ + 'description' => '播放模式。', + 'type' => 'string', + 'required' => true, + 'example' => 'loop', + ], + ], + [ + 'name' => 'AccessPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启访问控制。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '频道访问凭证。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + [ + 'name' => 'FillerSourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '垫片源位置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'FillerSourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '垫片源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'FillerSource', + ], + ], + [ + 'name' => 'OutPutConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '频道输出配置。', + 'type' => 'string', + 'required' => true, + 'example' => '[{'."\n" + .' "ManifestName": "manifest-1",'."\n" + .' "Format": "HLS",'."\n" + .' "SourceGroupName": "source-group-1",'."\n" + .' "ManifestSettings": {'."\n" + .' "WindowDuration": 60,'."\n" + .' "AdMarkType": "Daterange"'."\n" + .' }'."\n" + .'}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Channel' => [ + 'description' => '频道信息。', + '$ref' => '#/components/schemas/ChannelAssemblyChannel', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', + 'title' => '创建频道组装频道', + ], + 'ListSchedules' => [ + 'summary' => '获取节目单。', + 'description' => '调用ListSchedules接口获取节目单。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'WindowDurationSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '节目单窗口时长。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '14400', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小 default 10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Programs' => [ + 'description' => '节目单。', + 'type' => 'array', + 'items' => [ + 'description' => '日程信息。', + '$ref' => '#/components/schemas/ChannelAssemblyScheduleData', + ], + ], + 'PageNo' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，每页显示条数。默认值为20，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 5,\\n \\"Programs\\": [\\n {\\n \\"EntryType\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"OffsetMillis\\": \\"\\",\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ApproximateDurationSeconds\\": 0,\\n \\"ApproximateStartTime\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '列举频道组装节目单', + ], + 'ListSources' => [ + 'summary' => '列举源。', + 'description' => '调用ListSources接口列举源信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MyVodSource', + ], + ], + [ + 'name' => 'FilterState', + 'in' => 'query', + 'schema' => [ + 'description' => '是否过滤删除状态。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为 1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortByModifiedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按照修改时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认根据创建时间倒序', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNo' => [ + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '单页数据个数，默认为20，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SourceList' => [ + 'description' => '源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源信息。', + '$ref' => '#/components/schemas/ChannelAssemblySource', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"SourceList\\": [\\n {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列举频道组装源信息', + ], + 'ListAlerts' => [ + 'summary' => '获取警告信息。', + 'description' => '调用ListAlerts接口获取源警告信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'description' => '源或节目的资源描述。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/MySource', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '警告类型。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduling Error：构建日程时出错。'."\n" + .'PlayBack Warning：添加source时地址拉取异常。'."\n" + .'info：信息。'."\n", + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序参数，默认按创建时间倒序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'SortByModifiedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按照修改时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-21T16:10:45Z', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-22T16:10:45Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '符合条件的总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNo' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Alerts' => [ + 'description' => '警告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '警告信息详情。', + 'type' => 'object', + 'properties' => [ + 'ResourceArn' => [ + 'description' => '资源ARN。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/MySource', + ], + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ScheduleError', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'Category' => [ + 'description' => '分类', + 'type' => 'string', + 'example' => 'Scheduling Error：构建日程时出错。'."\n" + .'PlayBack Warning：添加source时地址拉取异常。'."\n" + .'info：信息。', + ], + 'RelatedResourceArns' => [ + 'description' => '相关资源ARN。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/MySource', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-07-16T10:03Z', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-07-16T10:03Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 100,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Alerts\\": [\\n {\\n \\"ResourceArn\\": \\"acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/MySource\\",\\n \\"Code\\": \\"ScheduleError\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"Category\\": \\"Scheduling Error：构建日程时出错。\\\\nPlayBack Warning：添加source时地址拉取异常。\\\\ninfo：信息。\\",\\n \\"RelatedResourceArns\\": \\"acs:ims:mediaweaver:<regionId>:<userId>:vodSource/mySourceLocation/MySource\\",\\n \\"GmtCreate\\": \\"2024-07-16T10:03Z\\",\\n \\"GmtModified\\": \\"2024-07-16T10:03Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取频道组装警告信息', + ], + 'GetChannel' => [ + 'summary' => '获取频道。', + 'description' => '调用GetChannel接口获取频道组装频道信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Channel' => [ + 'description' => '频道信息。', + '$ref' => '#/components/schemas/ChannelAssemblyChannel', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', + 'title' => '获取频道组装频道', + ], + 'CreateProgram' => [ + 'summary' => '创建一个新的节目。', + 'description' => '调用CreateProgram接口创建节目。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProgramName', + 'in' => 'query', + 'schema' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'program1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '节目的源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLcation', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySource', + ], + ], + [ + 'name' => 'Transition', + 'in' => 'query', + 'schema' => [ + 'description' => '节目转换信息。', + 'type' => 'string', + 'required' => true, + 'example' => '{"Type": "RELATIVE", "RelativePosition": "AFTER_PROGRAM", "RelativeProgram": "program2"}', + ], + ], + [ + 'name' => 'ClipRange', + 'in' => 'query', + 'schema' => [ + 'description' => '片段信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{StartOffsetMillis: 213123, EndOffsetMillis: 213134}', + ], + ], + [ + 'name' => 'AdBreaks', + 'in' => 'query', + 'schema' => [ + 'description' => '广告信息。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"MessageType":"SPLICE_INSERT","OffsetMillis":1000,"SourceLocationName":"MySourceLocation","SourceName":"MyAdSource","SpliceInsertSettings":{"AvailNumber":0,"AvailExpected":0,"SpliceEventID":1,"UniqueProgramID":0}}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Program' => [ + 'description' => '节目信息。', + '$ref' => '#/components/schemas/ChannelAssemblyProgram', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Program\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"AdBreaks\\": [\\n {\\n \\"TimeSignalSettings\\": \\"\\",\\n \\"OffsetMillis\\": 0,\\n \\"ChannelName\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"SpliceInsertSettings\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ProgramName\\": \\"\\",\\n \\"MessageType\\": \\"\\"\\n }\\n ],\\n \\"SourceType\\": \\"\\",\\n \\"Transition\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"ClipRange\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"ProgramName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '创建频道组装节目', + ], + 'ListChannelAlerts' => [ + 'summary' => '获取频道警告。', + 'description' => '调用ListChannelAlerts接口获取频道下资源的警告信息。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceArn', + 'in' => 'query', + 'schema' => [ + 'description' => '频道的资源描述。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:channel/myChannel', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '警告类型。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Scheduling Error：构建日程时出错。'."\n" + .'PlayBack Warning：添加source时地址拉取异常。'."\n" + .'info：信息。', + ], + ], + [ + 'name' => 'SortByModifiedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '按修改时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'GmtStart', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-21T16:10:45Z', + ], + ], + [ + 'name' => 'GmtEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-11-21T16:10:45Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'TotalCount' => [ + 'description' => '警告数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ProgramAlerts' => [ + 'description' => '节目警告列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Arn' => [ + 'description' => '节目ARN。', + 'type' => 'string', + 'example' => 'acs:ims:mediaweaver:<regionId>:<userId>:program/myChannel/MyProgram', + ], + 'ProgramName' => [ + 'description' => '节目名称。', + 'type' => 'string', + 'example' => 'program_name', + ], + 'Category' => [ + 'description' => '分类。', + 'type' => 'string', + 'example' => 'Scheduling Error：构建日程时出错。'."\n" + .'PlayBack Warning：添加source时地址拉取异常。'."\n" + .'info：信息。', + ], + 'Count' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2024-07-16T10:03Z', + ], + ], + ], + ], + 'PageNo' => [ + 'description' => '当前页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"TotalCount\\": 4,\\n \\"ProgramAlerts\\": [\\n {\\n \\"Arn\\": \\"acs:ims:mediaweaver:<regionId>:<userId>:program/myChannel/MyProgram\\",\\n \\"ProgramName\\": \\"program_name\\",\\n \\"Category\\": \\"Scheduling Error：构建日程时出错。\\\\nPlayBack Warning：添加source时地址拉取异常。\\\\ninfo：信息。\\",\\n \\"Count\\": 4,\\n \\"GmtModified\\": \\"2024-07-16T10:03Z\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => '列举频道组装频道警告信息', + ], + 'CreateSource' => [ + 'summary' => '创建一个新的源。', + 'description' => '调用CreateSource接口创建源。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '源位置名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源类型：vodSource,liveSource', + 'type' => 'string', + 'required' => true, + 'example' => 'vodSource', + ], + ], + [ + 'name' => 'SourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyVodSource', + ], + ], + [ + 'name' => 'HttpPackageConfigurations', + 'in' => 'query', + 'schema' => [ + 'description' => '源配置。', + 'type' => 'string', + 'required' => true, + 'example' => '“[{'."\n" + .' "sourceGroupName": "mySourceGroup-1",'."\n" + .' "relativePath": "group1/hls.m3u8",'."\n" + .' "type": "hls"'."\n" + .'}]”', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Source' => [ + 'description' => '源信息。', + '$ref' => '#/components/schemas/ChannelAssemblySource', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Source\\": {\\n \\"GmtCreate\\": \\"\\",\\n \\"SourceLocationName\\": \\"\\",\\n \\"State\\": 0,\\n \\"SourceType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"SourceName\\": \\"\\",\\n \\"HttpPackageConfigurations\\": \\"\\",\\n \\"Arn\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '创建频道组装源', + ], + 'UpdateChannel' => [ + 'summary' => '更新频道。', + 'description' => '调用UpdateChannel接口更新频道。', + 'path' => '/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道名称。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MyChannel', + ], + ], + [ + 'name' => 'AccessPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启访问控制。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '频道播放访问token。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + ], + [ + 'name' => 'FillerSourceLocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '垫片源位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySourceLocation', + ], + ], + [ + 'name' => 'FillerSourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '垫片源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySource', + ], + ], + [ + 'name' => 'OutPutConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '频道输出配置。', + 'type' => 'string', + 'required' => true, + 'example' => '[{'."\n" + .' "ManifestName": "manifest-1",'."\n" + .' "Format": "HLS",'."\n" + .' "SourceGroupName": "source-group-1",'."\n" + .' "ManifestSettings": {'."\n" + .' "WindowDuration": 60,'."\n" + .' "AdMarkType": "Daterange"'."\n" + .' }'."\n" + .'}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'description' => '创建成功', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '**请求ID**'."\n", + 'description' => '**请求ID**'."\n", + 'type' => 'string', + 'example' => 'xxx-xxxx-xxxxx-xxxx', + ], + 'Channel' => [ + 'description' => '频道信息。', + '$ref' => '#/components/schemas/ChannelAssemblyChannel', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxxx-xxxxx-xxxx\\",\\n \\"Channel\\": {\\n \\"FillerSourceName\\": \\"\\",\\n \\"FillerSourceLocationName\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"ChannelTier\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"State\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"Arn\\": \\"\\",\\n \\"PlaybackMode\\": \\"\\",\\n \\"OutPutConfigList\\": [\\n {\\n \\"ManifestName\\": \\"\\",\\n \\"ChannelName\\": \\"\\",\\n \\"Format\\": \\"\\",\\n \\"PlaybackUrl\\": \\"\\",\\n \\"ManifestSettings\\": \\"\\",\\n \\"SourceGroupName\\": \\"\\"\\n }\\n ],\\n \\"AccessPolicy\\": true\\n }\\n}","type":"json"}]', + 'title' => '更新频道组装频道', + ], + 'CreateVodPackagingGroup' => [ + 'summary' => '创建点播打包组。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'description' => '点播打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组描述信息。', + 'description' => '点播打包组描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod hls packaging', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '创建点播打包组返回。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PackagingGroup' => [ + 'description' => '点播打包组详情。', + '$ref' => '#/components/schemas/VodPackagingGroup', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingGroup\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建点播打包组', + ], + 'GetVodPackagingGroup' => [ + 'summary' => '获取点播打包组。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'description' => '点播打包组名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '查询点播打包组结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****36-3C1E-4417-BDB2-1E034F****', + ], + 'PackagingGroup' => [ + 'description' => '点播打包组详情。', + '$ref' => '#/components/schemas/VodPackagingGroup', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****36-3C1E-4417-BDB2-1E034F****\\",\\n \\"PackagingGroup\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '查询点播打包组', + ], + 'ListVodPackagingGroups' => [ + 'summary' => '列举点播打包组。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页查询页号，默认1。', + 'description' => '分页查询页号，默认1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页查询每页大小，默认10。', + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序规则，默认desc，可选：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'description' => '排序规则，默认desc，可选：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键词，指定查询过滤GroupName 包含Keyword的打包组。', + 'description' => '搜索关键词，列举查询点播打包组名称包含该关键词的打包组列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '列举点播打包组结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SortBy' => [ + 'title' => '排序规则，默认desc，可选：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'description' => '排序规则，默认desc，可选：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'PageNo' => [ + 'title' => '分页查询页号，默认1。', + 'description' => '分页查询页号，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页查询每页大小，默认10。', + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PackagingGroups' => [ + 'title' => '打包组列表。', + 'description' => '点播打包组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '点播打包组详情。', + '$ref' => '#/components/schemas/VodPackagingGroup', + ], + ], + 'TotalCount' => [ + 'title' => '总数。', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PackagingGroups\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"DomainName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ApproximateAssetCount\\": 0,\\n \\"ConfigurationCount\\": 0\\n }\\n ],\\n \\"TotalCount\\": 5\\n}","type":"json"}]', + 'title' => '列举点播打包组', + ], + 'DeleteVodPackagingGroup' => [ + 'summary' => '删除点播打包组。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '删除点播打包组结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '13cbb83e-043c-4728-ac35-*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"13cbb83e-043c-4728-ac35-*****\\"\\n}","type":"json"}]', + 'title' => '删除点播打包组', + ], + 'CreateVodPackagingConfiguration' => [ + 'summary' => '创建点播打包配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称，长度128个字符，格式：[A-Za-z0-9_-]+。', + 'description' => '点播打包组名称，长度128个字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + [ + 'name' => 'ConfigurationName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包配置名称，长度128个字符，格式：[A-Za-z0-9_-]+，用户维度唯一。', + 'description' => '点播打包配置名称，长度128个字符，格式：[A-Za-z0-9_-]+，用户维度唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls_3s', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'schema' => [ + 'title' => '打包类型，支持：'."\n" + .'- HLS: HLC协议播放格式；'."\n" + .'- HLS_CMAF： HLS协议的CMAF播放格式；'."\n" + .'- DASH: DASH协议播放格式。', + 'description' => '点播打包类型，支持：'."\n" + .'- HLS: HLC协议播放格式；'."\n" + .'- HLS_CMAF： HLS协议的CMAF播放格式；'."\n" + .'- DASH: DASH协议播放格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'HLS', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '打包配置描述信息。', + 'description' => '打包配置描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'HLS 3s vod packaging', + ], + ], + [ + 'name' => 'PackageConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '打包配置。', + 'description' => '打包配置。', + 'type' => 'object', + 'properties' => [ + 'ManifestName' => [ + 'title' => 'manifest名称，[A-Za-z0-9_]+，长度不超过128。', + 'description' => 'manifest名称，[A-Za-z0-9_]+，长度不超过128。', + 'type' => 'string', + 'required' => false, + 'example' => 'index', + ], + 'SegmentDuration' => [ + 'title' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', + 'description' => '每个片段的时长（以秒为单位）。实际片段将会被四舍五入到最接近的源片段时长的倍数。取值范围【1，30】。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6', + ], + 'StreamSelection' => [ + 'title' => '打包输出流选择配置。', + 'description' => '打包输出流选择配置。', + 'type' => 'object', + 'properties' => [ + 'MinVideoBitsPerSecond' => [ + 'title' => '最小视频流码率，单位bps。', + 'description' => '最小视频流码率，单位bps。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000', + ], + 'MaxVideoBitsPerSecond' => [ + 'title' => '最大视频流码率，单位bps。', + 'description' => '最大视频流码率，单位bps。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000', + ], + 'StreamOrder' => [ + 'title' => '流排序规则，支持值：'."\n" + .'- ORIGINAL：保持输入序号；'."\n" + .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" + .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', + 'description' => '流排序规则，支持值：'."\n" + .'- ORIGINAL：保持输入序号；'."\n" + .'- VIDEO_BITRATE_ASCENDING：按视频流码率递增；'."\n" + .'- VIDEO_BITRATE_DESCENDING：按视频流码率递减。', + 'type' => 'string', + 'required' => false, + 'example' => 'ORIGINAL', + ], + ], + 'required' => false, + ], + 'DrmProvider' => [ + 'title' => 'DRM加密提供商配置。', + 'description' => 'DRM加密提供商配置。', + 'type' => 'object', + 'properties' => [ + 'EncryptionMethod' => [ + 'title' => '加密算法，支持值：'."\n" + .'- AES_128'."\n" + .'- SAMPLE_AES', + 'description' => '加密算法，支持值：'."\n" + .'- AES_128：128位高级加密标准；'."\n" + .'- SAMPLE_AES：媒体内容保护领域的一个特定实现方式，抽样加密。', + 'type' => 'string', + 'required' => false, + 'example' => 'AES_128', + ], + 'IV' => [ + 'title' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', + 'description' => '一个可选的128位（16字节）十六进制值，由32个字符的字符串表示，与密钥一起用于加密数据块。如果您不指定该值，则MediaPackage将创建一个常量初始化向量（IV）。默认值：空，如果填写，则透传到供应商Constant initialization vector。', + 'type' => 'string', + 'required' => false, + 'example' => '00001111222233334444555566667777', + ], + 'SystemIds' => [ + 'title' => 'drm 系统id，system id数量由使用的协议类型决定。'."\n" + .'- DASH -- 最多两个'."\n" + .'- HLS -- 提供一个'."\n" + .'- HLS_CMAF-- 最多提供两个。'."\n" + .'只支持 Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM System，对应SystemId分别为 ：'."\n" + .'Apple FairPlay：'."\n" + .'94ce86fb-07ff-4f43-adb8-93d2fa968ca2'."\n" + .'Google Widevine：'."\n" + .'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'."\n" + .'Microsoft PlayReady：'."\n" + .'9a04f079-9840-4286-ab92-e65be0885f95。', + 'description' => 'DRM 系统id，system id数量由使用的协议类型决定，具体限制：'."\n" + .'- DASH -- 最多两个；'."\n" + .'- HLS -- 提供一个；'."\n" + .'- HLS_CMAF-- 最多提供两个。'."\n" + ."\n" + .'目前支持 Apple FairPlay、Google Widevine、Microsoft PlayReady 三个DRM System，对应SystemId分别为 ：'."\n" + .'- Apple FairPlay：94ce86fb-07ff-4f43-adb8-93d2fa968ca2；'."\n" + .'- Google Widevine：edef8ba9-79d6-4ace-a3c8-27dcd51d21e；'."\n" + .'- Microsoft PlayReady：9a04f079-9840-4286-ab92-e65be0885f95。', + 'type' => 'array', + 'items' => [ + 'description' => 'DRM系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => '94ce86fb-07ff-4f43-adb8-93d2fa968ca2', + ], + 'required' => false, + ], + 'Url' => [ + 'title' => 'DRM key提供商url。', + 'description' => 'DRM key提供商url。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://***drm***/getcontent', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PackagingConfiguration' => [ + 'title' => '打包配置。', + 'description' => '打包配置。', + '$ref' => '#/components/schemas/VodPackagingConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingConfiguration\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建点播打包配置', + ], + 'GetVodPackagingConfiguration' => [ + 'summary' => '查询打包模板配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigurationName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包配置名称。', + 'description' => '点播打包配置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls_3s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '查询点播打包配置结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'PackagingConfiguration' => [ + 'description' => '点播打包配置详情。', + '$ref' => '#/components/schemas/VodPackagingConfiguration', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"PackagingConfiguration\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询点播打包配置', + ], + 'ListVodPackagingConfigurations' => [ + 'summary' => '列举点播打包配置列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分压查询每页大小，默认10。', + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分压查询当前页，默认1。', + 'description' => '分页查询当前页，默认1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '列表排序，默认 desc：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'description' => '列表排序，默认 desc：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，列举查询点播打包配置名称包含该关键词的打包配置列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'SortBy' => [ + 'title' => '列表排序，默认 desc：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'description' => '列表排序，默认 desc：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'PageSize' => [ + 'title' => '分压查询每页大小，默认10。', + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNo' => [ + 'title' => '分压查询当前页，默认1。', + 'description' => '分页查询当前页，默认1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PackagingConfigurations' => [ + 'title' => '打包配置列表。', + 'description' => '打包配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '点播打包配置详情。', + '$ref' => '#/components/schemas/VodPackagingConfiguration', + ], + ], + 'TotalCount' => [ + 'title' => '总数。', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"PackagingConfigurations\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ConfigurationName\\": \\"\\",\\n \\"Protocol\\": \\"\\",\\n \\"PackageConfig\\": {\\n \\"ManifestName\\": \\"\\",\\n \\"StreamSelection\\": {\\n \\"MinVideoBitsPerSecond\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitsPerSecond\\": 0\\n },\\n \\"DrmProvider\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n }\\n ],\\n \\"TotalCount\\": 5\\n}","type":"json"}]', + 'title' => '列举点播打包配置', + ], + 'DeleteVodPackagingConfiguration' => [ + 'summary' => '删除点播打包配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigurationName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包配置名称。', + 'description' => '点播打包配置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls_3s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '删除点播打包配置结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除点播打包配置', + ], + 'CreateVodPackagingAsset' => [ + 'summary' => '创建vod打包资产。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + [ + 'name' => 'AssetName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'description' => '点播打包资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + 'required' => false, + 'example' => 'hls_3s', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '打包资产描述信息。', + 'description' => '点播打包资产描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'HLS 3 second packaging', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资产输入配置。', + 'description' => '资产输入配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '输入类型，暂支持OSS。', + 'description' => '输入类型，暂支持OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'description' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS://***test-bucket***/***video/input.m3u8', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ContentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', + 'description' => 'DRM系统中的内容ID，格式：[A-Za-z0-9_-]+，长度最多256。', + 'type' => 'string', + 'required' => false, + 'example' => 'movie', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '25818875-5F78-4A13-BEF6-D7393642CA58', + ], + 'Asset' => [ + 'description' => '点播打包资产详情。', + '$ref' => '#/components/schemas/VodPackagingAsset', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25818875-5F78-4A13-BEF6-D7393642CA58\\",\\n \\"Asset\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n },\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '创建点播打包资产', + ], + 'BatchCreateVodPackagingAsset' => [ + 'summary' => '批量创建vod打包资产。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Assets', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资产输入配置', + 'description' => '点播打包资产配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '资产输入配置。', + 'description' => '点播打包资产配置。', + 'type' => 'object', + 'properties' => [ + 'AssetName' => [ + 'title' => '打包资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'description' => '资产名称，用户维度唯一，长度128字符，格式：[A-Za-z0-9_-]+。', + 'type' => 'string', + 'required' => false, + 'example' => '30min_movie', + ], + 'ContentId' => [ + 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', + 'description' => 'DRM系统中的内容ID，格式：[A-Za-z0-9_-]+，长度最多256。', + 'type' => 'string', + 'required' => false, + 'example' => 'movie', + ], + 'Input' => [ + 'title' => '资产输入配置。', + 'description' => '资产输入配置。', + 'type' => 'object', + 'properties' => [ + 'Media' => [ + 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'description' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS://***test-bucket***/***video/input.m3u8', + ], + 'Type' => [ + 'title' => '输入类型，暂支持OSS。', + 'description' => '输入类型，暂支持OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '批量创建点播打包资产结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + 'GroupName' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'example' => 'vod_hls', + ], + 'ResultList' => [ + 'title' => '结果列表。', + 'description' => '创建结果列表。', + 'type' => 'array', + 'items' => [ + 'title' => '创建结果。', + 'description' => '创建结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '创建失败码。', + 'description' => '创建失败码。', + 'type' => 'string', + 'example' => 'InvalidParameter.PackagingAssetAlreadyExists', + ], + 'Message' => [ + 'title' => '创建失败详细信息。', + 'description' => '创建失败详细信息。', + 'type' => 'string', + 'example' => 'The specified packagingAsset "inputMovie" already exists', + ], + 'Asset' => [ + 'title' => '创建成功资产信息。', + 'description' => '创建成功资产信息。', + '$ref' => '#/components/schemas/VodPackagingAsset', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"ResultList\\": [\\n {\\n \\"Code\\": \\"InvalidParameter.PackagingAssetAlreadyExists\\",\\n \\"Message\\": \\"The specified packagingAsset \\\\\\"inputMovie\\\\\\" already exists\\",\\n \\"Asset\\": {\\n \\"GroupName\\": \\"\\",\\n \\"Input\\": {\\n \\"Type\\": \\"\\",\\n \\"Media\\": \\"\\"\\n },\\n \\"Description\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ContentId\\": \\"\\",\\n \\"AssetName\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量创建点播打包资产', + ], + 'GetVodPackagingAsset' => [ + 'summary' => '查询点播打包资产。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'AssetName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包资产名称。', + 'description' => '点播打包资产名称。', + 'type' => 'string', + 'required' => false, + 'example' => '30min_movie', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '查询点播打包资产结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0622C702-41BE-467E-AF2E-883D4517962E', + ], + 'Asset' => [ + 'title' => '打包资产信息。', + 'description' => '点播打包资产详情。', + 'type' => 'object', + 'properties' => [ + 'AssetName' => [ + 'title' => '打包资产名称。', + 'description' => '打包资产名称。', + 'type' => 'string', + 'example' => '30min_movie', + ], + 'GroupName' => [ + 'title' => '打包组名称。', + 'description' => '打包组名称。', + 'type' => 'string', + 'example' => 'vod_hls', + ], + 'Input' => [ + 'title' => '打包资产输入。', + 'description' => '打包资产输入。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '输入类型，暂支持OSS。', + 'description' => '输入类型，暂支持OSS。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'title' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'description' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'type' => 'string', + 'example' => 'OSS://***test-bucket***/***video/input.m3u8', + ], + ], + ], + 'CreateTime' => [ + 'title' => '资产创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32', + 'description' => '资产创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32', + 'type' => 'string', + 'example' => '2024-11-21T06:45:32Z', + ], + 'EgressEndpoints' => [ + 'title' => '资产打包播放输出端点列表，一个打包配置对应一个打包播放端点。', + 'description' => '资产打包播放输出端点列表，一个打包配置对应一个打包播放端点。', + 'type' => 'array', + 'items' => [ + 'title' => '资产打包播放端点。', + 'description' => '资产打包播放端点。', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'title' => '播放URL，当资产打包失败时不返回对应的播放URL。', + 'description' => '播放URL，当资产打包失败时不返回对应的播放URL。', + 'type' => 'string', + 'example' => 'https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8', + ], + 'Status' => [ + 'title' => '状态，支持值：'."\n" + .'- Queuing：排队处理中；'."\n" + .'- Playable: 可以播放；'."\n" + .'- Failed：打包失败，无法播放。', + 'description' => '状态，支持值：'."\n" + .'- Queuing：排队处理中；'."\n" + .'- Playable: 可以播放；'."\n" + .'- Failed：打包失败，无法播放。', + 'type' => 'string', + 'example' => 'Playable', + ], + 'ConfigurationName' => [ + 'title' => '打包配置名称。', + 'description' => '打包配置名称。', + 'type' => 'string', + 'example' => 'hls_3s', + ], + ], + ], + ], + 'ContentId' => [ + 'title' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', + 'description' => 'DRM系统中的内容id，格式：[A-Za-z0-9_-]+，长度最多256。', + 'type' => 'string', + 'example' => 'movie', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0622C702-41BE-467E-AF2E-883D4517962E\\",\\n \\"Asset\\": {\\n \\"AssetName\\": \\"30min_movie\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"OSS://***test-bucket***/***video/input.m3u8\\"\\n },\\n \\"CreateTime\\": \\"2024-11-21T06:45:32Z\\",\\n \\"EgressEndpoints\\": [\\n {\\n \\"Url\\": \\"https://y92kpc.**/v1/sy9gtc0w00i0bw2q33q2a4y71oydkofm/cvtcqv3lvrftd68k7f5avfjznvv0tje4/o3cfzi6c3qxo18ascgvnz7974qy3c02o/index.m3u8\\",\\n \\"Status\\": \\"Playable\\",\\n \\"ConfigurationName\\": \\"hls_3s\\"\\n }\\n ],\\n \\"ContentId\\": \\"movie\\"\\n }\\n}","type":"json"}]', + 'title' => '查询点播打包资产', + ], + 'ListVodPackagingAssets' => [ + 'summary' => '列举点播打包资产。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '分页查询当前页，默认1。', + 'description' => '分页查询当前页，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '分页查询每页大小，默认10。', + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '列表排序规则，默认 desc，可选:'."\n" + .'- desc： 按创建时间倒序排列；'."\n" + .'- asc：按创建时间正序排列。', + 'description' => '列表排序规则，默认 desc，可选：'."\n" + .'- desc： 按创建时间倒序排列；'."\n" + .'- asc：按创建时间正序排列。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '搜索关键词，指定查询过滤AssetName 以Keyword为前缀的资产列表。', + 'description' => '搜索关键词，列举查询点播打包资产名称以该关键词为前缀的打包资产列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'movie', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包组名称。', + 'description' => '点播打包组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_hls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Assets' => [ + 'description' => '点播打包资产配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产配置。', + 'type' => 'object', + 'properties' => [ + 'AssetName' => [ + 'description' => '点播打包资产名称。', + 'type' => 'string', + 'example' => '30min_movie', + ], + 'GroupName' => [ + 'description' => '点播打包组名称。', + 'type' => 'string', + 'example' => 'vod_hls', + ], + 'Description' => [ + 'description' => '打包资产描述信息。', + 'type' => 'string', + 'example' => 'movie 30min', + ], + 'Input' => [ + 'description' => '资产输入配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '输入类型，暂支持OSS。', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Media' => [ + 'description' => '输入媒资，目前只支持OSS路径，如 OSS://test-bucket/video/202208/test.m3u8。只支持后缀为.m3u8的输入。', + 'type' => 'string', + 'example' => 'OSS://***test-bucket***/***video/input.m3u8', + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间，格式 2024-11-21T06:45:32Z表示北京时间 2024-11-21 14:45:32。', + 'type' => 'string', + 'example' => '2024-11-21T06:45:32Z', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '分页查询每页大小，默认10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '分页查询当前页，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SortBy' => [ + 'description' => '列表排序，默认 desc：'."\n" + .'- desc：按创建时间倒序排序；'."\n" + .'- asc：按创建时间正序排序。', + 'type' => 'string', + 'example' => 'desc', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Assets\\": [\\n {\\n \\"AssetName\\": \\"30min_movie\\",\\n \\"GroupName\\": \\"vod_hls\\",\\n \\"Description\\": \\"movie 30min\\",\\n \\"Input\\": {\\n \\"Type\\": \\"OSS\\",\\n \\"Media\\": \\"OSS://***test-bucket***/***video/input.m3u8\\"\\n },\\n \\"CreateTime\\": \\"2024-11-21T06:45:32Z\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"SortBy\\": \\"desc\\"\\n}","type":"json"}]', + 'title' => '列举点播打包资产', + ], + 'DeleteVodPackagingAsset' => [ + 'summary' => '删除点播打包资产。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice20UKYV', + ], + ], + 'parameters' => [ + [ + 'name' => 'AssetName', + 'in' => 'query', + 'schema' => [ + 'title' => '打包资产名称。', + 'description' => '点播打包资产名称。', + 'type' => 'string', + 'required' => false, + 'example' => '30min_movie', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '删除点播打包资产返回。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '删除点播打包资产', + ], + 'CreateLivePackageChannelGroup' => [ + 'summary' => '用于创建一个新的实时打包服务频道组，支持自定义名称与描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238117', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '频道组名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-01', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '最大1000个字符'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '这是一个示例描述', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannelGroup' => [ + 'description' => '频道组'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）'."\n", + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => '这是一个示例描述', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'example-group', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'OriginDomain' => [ + 'title' => '源站域名', + 'description' => '源站域名', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '123e4567-e89b-12d3-a456-426614174000', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个示例描述\\",\\n \\"GroupName\\": \\"example-group\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example.com\\"\\n },\\n \\"RequestId\\": \\"123e4567-e89b-12d3-a456-426614174000\\"\\n}","type":"json"}]', + 'title' => '创建实时打包频道组', + 'description' => '通过此API，用户可以创建一个实时打包服务的新频道组。创建频道组会返回分配的源站域名。', + 'extraInfo' => '访问[错误中心](https://api.aliyun.com/document/ICE/2020-11-09/errorCode)查看错误码。', + ], + 'UpdateLivePackageChannelGroup' => [ + 'summary' => '更新实时打包服务中的频道组信息，包括描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238119', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '频道组名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组描述', + 'description' => '最大1000个字符'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '这是一个频道组。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannelGroup' => [ + 'description' => '频道组'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）'."\n", + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述'."\n", + 'type' => 'string', + 'example' => 'Updated description of the channel group.', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'example-group-name', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'OriginDomain' => [ + 'title' => '源站域名', + 'description' => '源站域名', + 'type' => 'string', + 'example' => 'example-origin.com', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"Updated description of the channel group.\\",\\n \\"GroupName\\": \\"example-group-name\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example-origin.com\\"\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\\\n\\"\\n}","type":"json"}]', + 'title' => '修改实时打包频道组', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，您可以修改实时打包服务中已创建的频道组的名称和描述信息。频道组名称须符合指定的字符规则，且描述长度不超过1000个字符。API响应将返回更新后的频道组详情及操作请求的唯一标识(RequestId)。'."\n", + ], + 'GetLivePackageChannelGroup' => [ + 'summary' => '通过频道组名称获取实时打包频道组的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238116', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannelGroup' => [ + 'description' => '频道组'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'Updated description of the channel group.', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'OriginDomain' => [ + 'title' => '源站域名', + 'description' => '源站域名', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroup\\": {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"Updated description of the channel group.\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"OriginDomain\\": \\"example.com\\"\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', + 'title' => '获取实时打包频道组', + 'description' => '## 请求说明'."\n" + ."\n" + .'使用本 API 可以查询指定频道组的详细配置，包括频道组名称、描述、源站域名以及创建和最后修改的时间戳。'."\n", + ], + 'ListLivePackageChannelGroups' => [ + 'summary' => '分页查询实时打包服务中的频道组信息，支持按名称或描述模糊搜索及排序。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238120', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '频道组名称或描述，支持模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'channel-group', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于1，不传默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页个数，范围：1～100，默认为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间升降排序。默认desc，降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannelGroups' => [ + 'title' => '数组，返回示例目录。', + 'description' => '数组，返回示例目录。', + 'type' => 'array', + 'items' => [ + 'title' => 'LivePackageChannelGroupItemType', + 'description' => 'LivePackageChannelGroupItemType', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '频道组创建时间，格式为`yyyy-MM-ddTHH:mm:ssZ（UTC时间）`。', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '频道组的描述信息。', + 'type' => 'string', + 'example' => '这是频道组的描述信息。', + ], + 'GroupName' => [ + 'title' => '资源一级ID', + 'description' => '频道组名称。', + 'type' => 'string', + 'example' => 'testChannelGroup', + ], + 'LastModified' => [ + 'title' => '修改时间', + 'description' => '频道组最后修改时间，格式为`yyyy-MM-ddTHH:mm:ssZ（UTC时间）`。', + 'type' => 'string', + 'example' => '2023-04-02T12:00:00Z', + ], + 'OriginDomain' => [ + 'title' => '源站域名', + 'description' => '源站域名。', + 'type' => 'string', + 'example' => 'origin.example.com', + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + 'SortBy' => [ + 'description' => '升降排序。', + 'type' => 'string', + 'example' => 'desc', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannelGroups\\": [\\n {\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是频道组的描述信息。\\",\\n \\"GroupName\\": \\"testChannelGroup\\",\\n \\"LastModified\\": \\"2023-04-02T12:00:00Z\\",\\n \\"OriginDomain\\": \\"origin.example.com\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => '查询实时打包频道组', + 'description' => '## 请求说明'."\n", + ], + 'DeleteLivePackageChannelGroup' => [ + 'summary' => '删除指定名称的实时打包频道组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238118', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '资源一级ID', + 'description' => '频道组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'group1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '资源一级ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', + 'title' => '删除实时打包频道组', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，您可以删除指定名称的实时打包频道组。'."\n" + .'删除前请确保该频道组下不包含频道。', + ], + 'CreateLivePackageChannel' => [ + 'summary' => '生成实时视频流处理频道，支持HLS协议，自动分配端点和密钥。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239700', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'SegmentCount', + 'in' => 'formData', + 'schema' => [ + 'title' => '切片个数', + 'description' => '输入流m3u8切片个数，2～100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道描述', + 'description' => '描述，最大1000个字符', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个测试频道', + ], + ], + [ + 'name' => 'SegmentDuration', + 'in' => 'formData', + 'schema' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长，1～30', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'title' => '协议', + 'description' => '输入协议，目前仅支持HLS', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannel' => [ + 'description' => '实时打包频道的具体信息', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'example-channel', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '频道描述', + 'description' => '描述', + 'type' => 'string', + 'example' => '这是一个测试频道', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IngestEndpoints' => [ + 'description' => '输入端点', + 'type' => 'array', + 'items' => [ + 'description' => '输入端点URL', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '输入端点ID', + 'type' => 'string', + 'example' => 'ingest1', + ], + 'Password' => [ + 'description' => '密码'."\n", + 'type' => 'string', + 'example' => '2F9e******b569c8', + ], + 'Url' => [ + 'description' => '输入端点URL'."\n", + 'type' => 'string', + 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'Username' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'us12******das', + ], + ], + ], + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Protocol' => [ + 'title' => '协议', + 'description' => '输入协议，HLS', + 'type' => 'string', + 'example' => 'HLS', + ], + 'SegmentCount' => [ + 'title' => '切片个数', + 'description' => '输入流m3u8切片个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SegmentDuration' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******3B-0E1A-586A-AC29-742247******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"example-channel\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个测试频道\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e******b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"******3B-0E1A-586A-AC29-742247******\\"\\n}","type":"json"}]', + 'title' => '创建实时打包频道', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口用于创建一个实时视频打包服务频道，目前支持HLS协议。系统将自动生成输入端点地址及认证所需的用户名和密码。'."\n" + ."\n" + .'### 注意事项'."\n" + ."\n" + .'- 频道组名称与频道名称只能包含大小写字母、数字、下划线和短横线。'."\n" + .'- 协议目前仅支持`HLS`。'."\n" + .'- 切片时长需设置在1至30秒之间。'."\n" + .'- m3u8切片个数需在2至100个之间。'."\n" + ."\n" + .'成功响应将返回新创建频道的详细信息，包括通道名、创建时间、修改时间、输入端点详情等。', + ], + 'UpdateLivePackageChannel' => [ + 'summary' => '更新实时打包服务中的频道配置，包括协议、时长与切片数量等。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239702', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道描述', + 'description' => '描述，最大1000个字符', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个测试频道', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'title' => '协议', + 'description' => '输入协议，目前仅支持HLS', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS', + ], + ], + [ + 'name' => 'SegmentCount', + 'in' => 'formData', + 'schema' => [ + 'title' => '切片个数', + 'description' => '输入流m3u8切片个数，2～100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'SegmentDuration', + 'in' => 'formData', + 'schema' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长，1～30', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的数据对象，包含更新后的实时打包频道信息及请求ID', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannel' => [ + 'description' => '实时打包频道的具体信息', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'channel-1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-07-16T02:24:42Z', + ], + 'Description' => [ + 'title' => '频道描述', + 'description' => '最大1000个字符的描述信息', + 'type' => 'string', + 'example' => '这是一个测试频道', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IngestEndpoints' => [ + 'description' => '输入端点数组'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '输入端点'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '输入端点ID', + 'type' => 'string', + 'example' => 'ingest1', + ], + 'Password' => [ + 'description' => '密码', + 'type' => 'string', + 'example' => '2F9e******b569c8', + ], + 'Url' => [ + 'description' => '输入端点URL', + 'type' => 'string', + 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'Username' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'us12******das', + ], + ], + ], + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2024-07-16T02:24:42Z', + ], + 'Protocol' => [ + 'title' => '协议', + 'description' => '输入流协议，支持HLS', + 'type' => 'string', + 'example' => 'HLS', + ], + 'SegmentCount' => [ + 'title' => '切片个数', + 'description' => '输入流切片个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SegmentDuration' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2024-07-16T02:24:42Z\\",\\n \\"Description\\": \\"这是一个测试频道\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e******b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2024-07-16T02:24:42Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', + 'title' => '修改实时打包频道', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，您可以修改实时打包服务中指定频道的配置信息。需要提供频道所在的频道组名称、频道名称，以及要更新的协议类型、分段时长和分段数量。此外，您还可以选择性地添加或修改频道的描述信息。请确保提供的频道组名称与频道名称符合规范要求。'."\n", + ], + 'UpdateLivePackageChannelCredentials' => [ + 'summary' => '实时打包服务API，用于刷新指定频道的输入端点密钥。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240167', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'RotateCredentials', + 'in' => 'formData', + 'schema' => [ + 'title' => '刷新密钥选项', + 'description' => '是否刷新密钥, 1: 刷新端点1密钥，2: 刷新端点2密钥，3: 刷新端点1&2密钥', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'IngestEndpoints' => [ + 'description' => '输入端点URL', + 'type' => 'array', + 'items' => [ + 'description' => '用户名', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '输入端点ID，`input1`为主, `input2`为备', + 'type' => 'string', + 'example' => 'input1', + ], + 'Password' => [ + 'description' => '密码', + 'type' => 'string', + 'example' => 'examplePassword123', + ], + 'Url' => [ + 'description' => '输入端点URL', + 'type' => 'string', + 'example' => 'rtmp://example.com/live/input1', + ], + 'Username' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'user1', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"input1\\",\\n \\"Password\\": \\"examplePassword123\\",\\n \\"Url\\": \\"rtmp://example.com/live/input1\\",\\n \\"Username\\": \\"user1\\"\\n }\\n ],\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', + 'title' => '更新频道密钥', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口允许用户更新频道组内指定频道的推流接入凭据（endpoint 密钥）。用户可选择刷新主 endpoint、备 endpoint 或同时刷新两者。返回信息中将包含更新后的输入端点 URL、用户名及密码等详情，以便推流设备重新配置使用。'."\n", + ], + 'GetLivePackageChannel' => [ + 'summary' => '查询指定频道的实时打包配置详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239699', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannel' => [ + 'description' => '实时打包频道的具体信息', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'ch4', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '频道描述', + 'description' => '频道描述', + 'type' => 'string', + 'example' => '测试频道', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IngestEndpoints' => [ + 'description' => '输入端点数组', + 'type' => 'array', + 'items' => [ + 'description' => '输入端点', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '输入端点ID', + 'type' => 'string', + 'example' => 'ingest1', + ], + 'Password' => [ + 'description' => '密码', + 'type' => 'string', + 'example' => '2F9e******b569c8', + ], + 'Url' => [ + 'description' => '输入端点URL', + 'type' => 'string', + 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest'."\n", + ], + 'Username' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'us12******das', + ], + ], + ], + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Protocol' => [ + 'title' => '协议', + 'description' => '输入协议，HLS', + 'type' => 'string', + 'example' => 'HLS', + ], + 'SegmentCount' => [ + 'title' => '切片个数', + 'description' => '输入流m3u8切片个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SegmentDuration' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的唯一标识符。', + 'type' => 'string', + 'example' => 'RequestId-12345678', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannel\\": {\\n \\"ChannelName\\": \\"ch4\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"测试频道\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e******b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\\\n\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n },\\n \\"RequestId\\": \\"RequestId-12345678\\"\\n}","type":"json"}]', + 'title' => '获取实时打包频道', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，您可以查询指定频道下的实时打包频道详细信息，包括但不限于频道创建时间、描述、输入端点、协议、切片个数与切片时长等配置。'."\n", + ], + 'ListLivePackageChannels' => [ + 'summary' => '按频道组与关键词查询实时打包频道列表，支持分页和排序。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239703', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'title' => '列表过滤参数', + 'description' => '频道名称或描述，支持模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'group-1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认值：1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认值10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间升降排序。默认desc，降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageChannels' => [ + 'title' => '数组，返回示例目录。', + 'description' => '实时打包频道列表', + 'type' => 'array', + 'items' => [ + 'title' => 'LivePackageChannelItemType', + 'description' => 'LivePackageChannelItemType', + 'type' => 'object', + 'properties' => [ + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'ch3', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z'."\n", + ], + 'Description' => [ + 'title' => '频道描述', + 'description' => '频道描述', + 'type' => 'string', + 'example' => '测试频道', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IngestEndpoints' => [ + 'description' => '输入端点数组', + 'type' => 'array', + 'items' => [ + 'description' => '输入端点', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '输入端点ID', + 'type' => 'string', + 'example' => 'ingest1', + ], + 'Password' => [ + 'description' => '密码', + 'type' => 'string', + 'example' => '2F9e9******18b569c8', + ], + 'Url' => [ + 'description' => '输入端点URL', + 'type' => 'string', + 'example' => 'http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'Username' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'us12******das', + ], + ], + ], + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Protocol' => [ + 'title' => '协议', + 'description' => '输入协议，HLS', + 'type' => 'string', + 'example' => 'HLS', + ], + 'SegmentCount' => [ + 'title' => '切片个数', + 'description' => '输入流m3u8切片个数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SegmentDuration' => [ + 'title' => '切片时长', + 'description' => '输入流切片时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页记录数。', + 'description' => '每页大小，[1, 100]，不传默认为10', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识', + 'type' => 'string', + 'example' => 'RequestId的示例值', + ], + 'SortBy' => [ + 'description' => '排序方式，asc，desc（默认）', + 'type' => 'string', + 'example' => 'asc/desc', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageChannels\\": [\\n {\\n \\"ChannelName\\": \\"ch3\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\\\n\\",\\n \\"Description\\": \\"测试频道\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IngestEndpoints\\": [\\n {\\n \\"Id\\": \\"ingest1\\",\\n \\"Password\\": \\"2F9e9******18b569c8\\",\\n \\"Url\\": \\"http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"Username\\": \\"us12******das\\"\\n }\\n ],\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"SegmentCount\\": 3,\\n \\"SegmentDuration\\": 5\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"RequestId的示例值\\",\\n \\"SortBy\\": \\"asc/desc\\",\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + 'title' => '查询实时打包频道', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口允许用户根据指定的**GroupName**和可选的**Keyword**查询实时打包频道列表。结果可以按创建时间等进行升序或降序排序，并支持分页查询，以便于管理和检索大量频道信息。'."\n" + ."\n" + .'- **GroupName** 是必填项，用于指定频道所在的频道组。'."\n" + .'- **Keyword** 支持模糊匹配频道名称或描述，有助于快速过滤所需频道。'."\n" + .'- **PageNo** 和 **PageSize** 参数可以帮助控制返回结果的分页，方便分批处理数据。'."\n" + .'- **SortBy** 参数允许用户自定义结果排序方式，默认按降序排列。'."\n" + ."\n" + .'注意检查返回的**RequestId**用于后续问题排查，同时关注**TotalCount**了解符合条件的总频道数量。'."\n", + ], + 'DeleteLivePackageChannel' => [ + 'summary' => '根据GroupName和ChannelName删除指定的实时打包频道。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239701', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\"\\n}","type":"json"}]', + 'title' => '删除实时打包频道', + 'description' => '## 请求说明'."\n" + ."\n" + .'通过此API，您可以删除特定的实时打包频道。需要提供GroupName和ChannelName作为参数，以精确指定要删除的频道。'."\n" + .'删除频道前需先删除频道关联的源站端点。', + ], + 'CreateLivePackageOriginEndpoint' => [ + 'summary' => '用于添加实时流媒体频道的源站端点配置，支持HLS、HLS_CMAF和DASH协议及DRM加密。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239771', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'formData', + 'schema' => [ + 'title' => '端点名称', + 'description' => '源站端点名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'endpoint-1', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'title' => '分发协议', + 'description' => '分发协议', + 'type' => 'string', + 'required' => true, + 'example' => 'HLS', + ], + ], + [ + 'name' => 'ManifestName', + 'in' => 'formData', + 'schema' => [ + 'title' => '清单名称', + 'description' => '清单名称，默认manifest', + 'type' => 'string', + 'required' => false, + 'example' => 'manifest', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个源站端点', + ], + ], + [ + 'name' => 'TimeshiftVision', + 'in' => 'formData', + 'schema' => [ + 'title' => '时移天数', + 'description' => '时移天数，最大30天，默认为0表示不支持时移', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AuthorizationCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '回源授权码', + 'description' => '授权码，与IpWhitelist至少设置一个，最长200字符。格式：[A-Za-z0-9-_.]+', + 'type' => 'string', + 'required' => false, + 'example' => 'AbcDef123', + ], + ], + [ + 'name' => 'IpWhitelist', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单，支持掩码，不允许配置0.0.0.0/0，多个使用逗号分隔，与AuthorizationCode至少设置一个，最大1000字符', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + ], + [ + 'name' => 'IpBlacklist', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单，支持掩码，不允许配置0.0.0.0/0，多个使用逗号分隔，最大1000字符', + 'type' => 'string', + 'required' => false, + 'example' => '103.21.222.1/32,192.168.100.0/24', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '****0311a423d11a5f7dee713535****', + ], + ], + [ + 'name' => 'LivePackagingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '直播封装配置', + 'required' => false, + '$ref' => '#/components/schemas/LivePackagingConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageOriginEndpoint' => [ + 'description' => 'LivePackageOriginEndpoint类型', + 'type' => 'object', + 'properties' => [ + 'AuthorizationCode' => [ + 'title' => '回源授权码', + 'description' => '授权码', + 'type' => 'string', + 'example' => 'Abcded123', + ], + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'channel-1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'example' => '这是一个源站端点', + ], + 'EndpointName' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'example' => 'endpoint-1', + ], + 'EndpointUrl' => [ + 'title' => '端点URL', + 'description' => '端点播放地址', + 'type' => 'string', + 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IpBlacklist' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单', + 'type' => 'string', + 'example' => '103.21.222.1/32,192.168.100.0/24', + ], + 'IpWhitelist' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单', + 'type' => 'string', + 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'ManifestName' => [ + 'title' => '清单名称', + 'description' => '清单名称', + 'type' => 'string', + 'example' => 'manifest', + ], + 'Protocol' => [ + 'title' => '分发协议', + 'description' => '协议，暂只支持HLS', + 'type' => 'string', + 'example' => 'HLS', + ], + 'TimeshiftVision' => [ + 'title' => '时移天数', + 'description' => '时移天数，最大30天', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LivePackagingConfig' => [ + 'description' => '直播封装配置', + '$ref' => '#/components/schemas/LivePackagingConfig', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abcded123\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"103.21.222.1/32,192.168.100.0/24\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 1,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\"\\n}","type":"json"}]', + 'title' => '创建实时打包源站端点', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口允许用户创建一个实时打包服务的源站端点，主要用于配置频道的回源、安全策略（如IP黑白名单及授权码）及时移功能。目前仅支持HLS协议播放。创建源站端点前，需先创建好实时打包频道组和频道。创建成功后，将返回端点播放地址及其他配置详情。', + ], + 'UpdateLivePackageOriginEndpoint' => [ + 'summary' => '更新频道组的实时打包源站端点配置，支持协议、时移设置及访问控制。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239773', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '已创建的频道组名称。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'formData', + 'schema' => [ + 'title' => '频道名称', + 'description' => '已创建的频道名称。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'formData', + 'schema' => [ + 'title' => '端点名称', + 'description' => '源站端点名称，字符必须为大小写英文字母、数字、短横线、下划线。1 ~ 200个字符。格式：[A-Za-z0-9_-]+', + 'type' => 'string', + 'required' => true, + 'example' => 'endpoint-1', + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => [ + 'title' => '分发协议', + 'description' => '协议，暂只支持HLS'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'HLS', + ], + ], + [ + 'name' => 'ManifestName', + 'in' => 'formData', + 'schema' => [ + 'title' => '清单名称', + 'description' => '播放列表名，缺省为manifest'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'manifest', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个源站端点', + ], + ], + [ + 'name' => 'TimeshiftVision', + 'in' => 'formData', + 'schema' => [ + 'title' => '时移天数', + 'description' => '时移天数，最大30天', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'AuthorizationCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '回源授权码', + 'description' => '授权码，与IpWhitelist至少设置一个，最长200字符。格式：[A-Za-z0-9-_.]+', + 'type' => 'string', + 'required' => false, + 'example' => 'Abc123Def456', + ], + ], + [ + 'name' => 'IpWhitelist', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单，支持掩码，不允许配置0.0.0.0/0，多个使用逗号分隔，与AuthorizationCode至少设置一个，最大1000字符', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24,10.0.0.1', + ], + ], + [ + 'name' => 'IpBlacklist', + 'in' => 'formData', + 'schema' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单，支持掩码，逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => '103.0.0.0/8', + ], + ], + [ + 'name' => 'LivePackagingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '直播封装配置', + 'required' => false, + '$ref' => '#/components/schemas/LivePackagingConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageOriginEndpoint' => [ + 'description' => '源站端点类型', + 'type' => 'object', + 'properties' => [ + 'AuthorizationCode' => [ + 'title' => '回源授权码', + 'description' => '授权码', + 'type' => 'string', + 'example' => 'Abc123Def456', + ], + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'channel-1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'example' => '这是一个源站端点', + ], + 'EndpointName' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'example' => 'endpoint-1', + ], + 'EndpointUrl' => [ + 'title' => '端点URL', + 'description' => '端点URL', + 'type' => 'string', + 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IpBlacklist' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单，支持掩码，逗号分隔'."\n", + 'type' => 'string', + 'example' => '10.21.222.1/32,192.168.100.0/24', + ], + 'IpWhitelist' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单，支持掩码，逗号分隔', + 'type' => 'string', + 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'ManifestName' => [ + 'title' => '清单名称', + 'description' => '播放列表名，缺省为manifest'."\n", + 'type' => 'string', + 'example' => 'manifest', + ], + 'Protocol' => [ + 'title' => '分发协议', + 'description' => '协议，暂只支持HLS'."\n", + 'type' => 'string', + 'example' => 'HLS', + ], + 'TimeshiftVision' => [ + 'title' => '时移天数', + 'description' => '时移天数，最大30天', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LivePackagingConfig' => [ + 'description' => '直播封装配置', + '$ref' => '#/components/schemas/LivePackagingConfig', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"10.21.222.1/32,192.168.100.0/24\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 5,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', + 'title' => '修改实时打包源站端点', + 'description' => '## 请求说明'."\n" + ."\n" + .'本接口用于修改指定频道组下实时打包服务的源站端点配置。您可以通过此接口调整回源协议、设定时移天数、定义播放列表名称以及配置IP黑白名单等，以实现对实时流媒体分发的精细化管理。请注意，部分参数为必填项，且IP白名单与回源请求头需至少提供一个。'."\n", + ], + 'GetLivePackageOriginEndpoint' => [ + 'summary' => '查询指定频道的实时流打包源站配置详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239770', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'query', + 'schema' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'required' => true, + 'example' => 'endpoint-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageOriginEndpoint' => [ + 'description' => '源站端点类型', + 'type' => 'object', + 'properties' => [ + 'AuthorizationCode' => [ + 'title' => '回源授权码', + 'description' => '授权码', + 'type' => 'string', + 'example' => 'Abc123Def456', + ], + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'channel-1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'example' => '这是一个源站端点', + ], + 'EndpointName' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'example' => 'endpoint-1', + ], + 'EndpointUrl' => [ + 'title' => '端点URL', + 'description' => '端点URL', + 'type' => 'string', + 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IpBlacklist' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单', + 'type' => 'string', + 'example' => '10.21.222.1/32', + ], + 'IpWhitelist' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单', + 'type' => 'string', + 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'ManifestName' => [ + 'title' => '清单名称', + 'description' => '清单名称', + 'type' => 'string', + 'example' => 'manifest', + ], + 'Protocol' => [ + 'title' => '分发协议', + 'description' => '分发协议', + 'type' => 'string', + 'example' => 'HLS', + ], + 'TimeshiftVision' => [ + 'title' => '时移天数', + 'description' => '时移天数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LivePackagingConfig' => [ + 'description' => '直播封装配置', + '$ref' => '#/components/schemas/LivePackagingConfig', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoint\\": {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"10.21.222.1/32\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 5,\\n \\"LivePackagingConfig\\": {\\n \\"LiveManifestConfigs\\": [\\n {\\n \\"SegmentCount\\": 0,\\n \\"AdMarkers\\": \\"\\",\\n \\"MinVideoBitrate\\": 0,\\n \\"MinBufferTime\\": 0,\\n \\"PresentationDelay\\": 0,\\n \\"StreamOrder\\": \\"\\",\\n \\"MaxVideoBitrate\\": 0,\\n \\"DateTimeInterval\\": 0,\\n \\"SegmentTemplateFormat\\": \\"\\",\\n \\"MinUpdatePeriod\\": 0,\\n \\"ManifestDuration\\": 0\\n }\\n ],\\n \\"UseAudioRenditionGroups\\": true,\\n \\"DrmConfig\\": {\\n \\"SystemIds\\": [\\n \\"\\"\\n ],\\n \\"RotatePeriod\\": 0,\\n \\"ContentId\\": \\"\\",\\n \\"EncryptionMethod\\": \\"\\",\\n \\"IV\\": \\"\\",\\n \\"Url\\": \\"\\"\\n },\\n \\"SegmentDuration\\": 0\\n }\\n },\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', + 'title' => '获取实时打包源站端点', + 'description' => '## 请求说明'."\n", + ], + 'ListLivePackageOriginEndpoints' => [ + 'summary' => '按频道组和频道名称查询实时打包源站端点，支持分页和排序。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239774', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '端点名称或描述，支持模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'endpoint-', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '按创建时间排序方式，asc升序，desc降序（默认）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'asc' => 'asc', + 'desc' => 'desc', + ], + 'example' => 'desc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'LivePackageOriginEndpoints' => [ + 'title' => '数组，返回示例目录。', + 'description' => '数组，返回示例目录。', + 'type' => 'array', + 'items' => [ + 'title' => 'LivePackageOriginEndpointItemType', + 'description' => 'LivePackageOriginEndpointItemType', + 'type' => 'object', + 'properties' => [ + 'AuthorizationCode' => [ + 'title' => '回源授权码', + 'description' => '授权码', + 'type' => 'string', + 'example' => 'Abc123Def456', + ], + 'ChannelName' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'example' => 'channel-1', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'Description' => [ + 'title' => '端点描述', + 'description' => '端点描述', + 'type' => 'string', + 'example' => '这是一个源站端点', + ], + 'EndpointName' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'example' => 'endpoint-1', + ], + 'EndpointUrl' => [ + 'title' => '端点URL', + 'description' => '端点URL', + 'type' => 'string', + 'example' => 'https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest.m3u8', + ], + 'GroupName' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'example' => 'channel-group-1', + ], + 'IpBlacklist' => [ + 'title' => 'IP黑名单', + 'description' => 'IP黑名单', + 'type' => 'string', + 'example' => '10.21.222.1/32,192.168.100.0/24', + ], + 'IpWhitelist' => [ + 'title' => 'IP白名单', + 'description' => 'IP白名单', + 'type' => 'string', + 'example' => '192.168.1.0/24,10.0.0.1/24', + ], + 'LastModified' => [ + 'title' => '最后修改时间', + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2023-04-01T12:00:00Z', + ], + 'ManifestName' => [ + 'title' => '清单名称', + 'description' => '清单名称', + 'type' => 'string', + 'example' => 'manifest', + ], + 'Protocol' => [ + 'title' => '分发协议', + 'description' => '分发协议', + 'type' => 'string', + 'example' => 'HLS', + ], + 'TimeshiftVision' => [ + 'title' => '时移天数', + 'description' => '时移天数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageNo' => [ + 'title' => '页码。', + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页记录数。', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识ID。', + 'type' => 'string', + 'example' => 'b9f90a7ac8904db28dc18e0c2a72c75d', + ], + 'SortBy' => [ + 'description' => '排序方式，`asc`升序，`desc`降序（默认）。', + 'type' => 'string', + 'example' => 'desc', + ], + 'TotalCount' => [ + 'title' => '总记录数。', + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LivePackageOriginEndpoints\\": [\\n {\\n \\"AuthorizationCode\\": \\"Abc123Def456\\",\\n \\"ChannelName\\": \\"channel-1\\",\\n \\"CreateTime\\": \\"2023-04-01T12:00:00Z\\",\\n \\"Description\\": \\"这是一个源站端点\\",\\n \\"EndpointName\\": \\"endpoint-1\\",\\n \\"EndpointUrl\\": \\"https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest.m3u8\\",\\n \\"GroupName\\": \\"channel-group-1\\",\\n \\"IpBlacklist\\": \\"10.21.222.1/32,192.168.100.0/24\\",\\n \\"IpWhitelist\\": \\"192.168.1.0/24,10.0.0.1/24\\",\\n \\"LastModified\\": \\"2023-04-01T12:00:00Z\\",\\n \\"ManifestName\\": \\"manifest\\",\\n \\"Protocol\\": \\"HLS\\",\\n \\"TimeshiftVision\\": 1\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"b9f90a7ac8904db28dc18e0c2a72c75d\\",\\n \\"SortBy\\": \\"desc\\",\\n \\"TotalCount\\": 10\\n}","type":"json"}]', + 'title' => '查询实时打包源站端点列表', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口允许用户根据指定的频道查询实时打包服务中的源站端点列表。结果包含源站端点的详细配置信息，如访问URL、协议类型、安全策略等。此外，还支持分页查询和按创建时间排序。', + ], + 'DeleteLivePackageOriginEndpoint' => [ + 'summary' => '删除指定频道下的实时打包源端点配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239772', + 'abilityTreeNodes' => [ + 'FEATUREiceQU6W9M', + ], + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道组名称', + 'description' => '频道组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-group-1', + ], + ], + [ + 'name' => 'ChannelName', + 'in' => 'query', + 'schema' => [ + 'title' => '频道名称', + 'description' => '频道名称', + 'type' => 'string', + 'required' => true, + 'example' => 'channel-1', + ], + ], + [ + 'name' => 'EndpointName', + 'in' => 'query', + 'schema' => [ + 'title' => '端点名称', + 'description' => '端点名称', + 'type' => 'string', + 'required' => true, + 'example' => 'endpoint-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5D87B753-0250-5D9D-B248-D40C3271F864', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5D87B753-0250-5D9D-B248-D40C3271F864\\"\\n}","type":"json"}]', + 'title' => '删除实时打包源端点', + 'description' => '## 请求说明'."\n" + ."\n" + .'本接口用于删除指定分组和频道下的实时打包源端点配置。通过传入`GroupName`、`ChannelName`和`EndpointName`来定位并删除相应的源端点设置。请注意，此操作将永久移除相关配置，请谨慎操作。'."\n", + ], + 'SetContentAnalyzeConfig' => [ + 'summary' => '调用SetContentAnalyzeConfig 设置智能内容分析的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Auto', + 'in' => 'query', + 'schema' => [ + 'description' => '媒资注册完成后是否自动发起智能内容分析。'."\n" + ."\n" + .'取值：'."\n" + .'- true：开启'."\n" + .'- false：不开启，默认为false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SaveType', + 'in' => 'query', + 'schema' => [ + 'description' => '分析结果入库类型，仅当Auto = true 时可配置。默认值为空。'."\n" + .'- TEXT: 标签'."\n" + .'- FACE：人脸'."\n" + .'- DNA：相似图'."\n" + ."\n" + .'支持多值，多值以半角逗号（,）分隔。如果此字段为空，智能内容分析的结果默认不入任何搜索库，后续也无法进行任何形式的内容搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'TEXT,FACE', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能内容分析模板ID。各模板包含以下AI分析功能：'."\n" + .'- S00000101-100040 : 文字识别'."\n" + .'- S00000101-100060 : 视频分类+人脸识别'."\n" + .'- S00000101-100070 : 文字识别+视频分类+人脸识别', + 'type' => 'string', + 'required' => false, + 'example' => 'S00000101-100070', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '953CFD27-4A2C-54AD-857F-B79EF3A338E0', + ], + 'Success' => [ + 'title' => '是否设置成功', + 'description' => '是否设置成功。取值：'."\n" + .'- true： 成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"953CFD27-4A2C-54AD-857F-B79EF3A338E0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '设置智能内容分析配置', + ], + 'GetContentAnalyzeConfig' => [ + 'summary' => '调用GetContentAnalyzeConfig获取智能内容分析的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '31FEC819-2344-5771-9366-9172DB0D26C9', + ], + 'ContentAnalyzeConfig' => [ + 'description' => '智能内容分析配置。', + 'type' => 'object', + 'properties' => [ + 'Auto' => [ + 'description' => '媒资注册完成后是否自动发起智能内容分析。'."\n" + ."\n" + .'取值：'."\n" + .'- true：开启'."\n" + .'- false：不开启，默认为false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SaveType' => [ + 'description' => '分析结果入库类型，仅当Auto = true 时可配置。默认值为空。'."\n" + .'- TEXT: 标签'."\n" + .'- FACE：人脸'."\n" + .'- DNA：相似图'."\n" + ."\n" + .'支持多值，多值以半角逗号（,）分隔。如果此字段为空，智能内容分析的结果默认不入任何搜索库，后续也无法进行任何形式的内容搜索。', + 'type' => 'string', + 'example' => 'TEXT,FACE', + ], + 'TemplateId' => [ + 'description' => '智能内容分析模板ID。各模板包含以下AI分析功能：'."\n" + .'- S00000101-100040 : 文字识别'."\n" + .'- S00000101-100060 : 视频分类+人脸识别'."\n" + .'- S00000101-100070 : 文字识别+视频分类+人脸识别', + 'type' => 'string', + 'example' => 'S00000101-100070', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"31FEC819-2344-5771-9366-9172DB0D26C9\\",\\n \\"ContentAnalyzeConfig\\": {\\n \\"Auto\\": true,\\n \\"SaveType\\": \\"TEXT,FACE\\",\\n \\"TemplateId\\": \\"S00000101-100070\\"\\n }\\n}","type":"json"}]', + 'title' => '获取智能内容分析配置', + ], + 'SetDefaultStorageLocation' => [ + 'summary' => '设置临时文件的默认存储路径。默认存储地址用于ICE在线编辑器及集成webSDK使用时，剪辑过程产生的临时文件存储，如智能配置生成的音频文件等；设置默认存储地址，可避免在编辑过程中申请填写各类临时资源的存储路径时，对使用者造成困扰；如果通过API接入ICE剪辑能力，可在接口中灵活设置路径，此默认路径不生效。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型：'."\n" + .'- vod\\_oss\\_bucket: vod托管Bucket。'."\n" + .'支持添加点播系统Bucket和在点播系统中添加的OSS自有Bucket。如果没有可用的，您也可以到视频点播控制台新增Bucket，视频点播系统会在每一个存储地域分配一个存储地址，开通视频点播服务后需要启用该地址才能使用，详细操作请参见[管理存储Bucket](~~86097~~)。'."\n" + .'- user\\_oss\\_bucket: 用户私有Bucket。添加对象存储地址前，您需要开通对象存储OSS服务并创建存储Bucket，详细操作请参见[控制台创建存储空间](~~31885~~)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'user_oss_bucket' => '用户私有bucket', + 'vod_oss_bucket' => 'vod托管bucket', + ], + 'example' => 'user_oss_bucket', + ], + ], + [ + 'name' => 'Bucket', + 'in' => 'query', + 'schema' => [ + 'description' => '您创建的OSS的Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss-test-bucket', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当storageType为user_oss_bucket时，临时文件会被存储到这个路径下，path为空或/时表示存储在根目录。'."\n" + .'- 对于vod存储该字段不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ims/dir', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******5A-CAAC-4850-A3AF-B74606******', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******5A-CAAC-4850-A3AF-B74606******\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDefaultStorageLocationResponse>\\n <RequestId>******5A-CAAC-4850-A3AF-B74606******</RequestId>\\n <Success>true</Success>\\n</SetDefaultStorageLocationResponse>","errorExample":""}]', + 'title' => '设置默认存储位置', + 'description' => '-智能媒体服务可使用对象存储或视频点播存储，请根据您所需存储类型，开通对应服务。二者区别如下：'."\n" + .'- 视频点播存储：视频点播提供视频存储、媒资管理、CDN播放服务等一站式音视频解决方案。存储至视频点播，智能媒体服务为点播提供能力加持，可基于视频点播提供的API实现视频业务的快速开发上线。'."\n" + .'- 对象存储：对象存储是阿里云提供的海量、安全、低成本、高持久性的云存储服务。可基于智能媒体服务和对象存储的能力实现多场景音视频业务的开发。'."\n" + ."\n" + .'-您还可通过控制台配置存储地址，详情请参见[配置存储地址](~~609918~~)。'."\n" + ."\n" + .'-存储费用根据您配置的存储地址在OSS或视频点播（VOD）中计费。详情请参见：[媒资存储计费](~~440701~~)。', + ], + 'GetDefaultStorageLocation' => [ + 'summary' => '本文为您介绍获取默认存储配置API请求参数及示例。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'StorageType' => [ + 'title' => '存储类型', + 'description' => '存储类型', + 'type' => 'string', + 'example' => 'user_oss_bucket', + ], + 'Bucket' => [ + 'title' => 'oss bucket 名称', + 'description' => 'oss bucket 名称', + 'type' => 'string', + 'example' => 'oss-test-bucket', + ], + 'Path' => [ + 'title' => '路径', + 'description' => '路径', + 'type' => 'string', + 'example' => 'ice/dir', + ], + 'Status' => [ + 'title' => '状态', + 'description' => 'bucket状态：'."\n" + .'- normal：bucket状态正常'."\n" + .'- notExist：bucket 不存在', + 'type' => 'string', + 'example' => 'normal', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"StorageType\\": \\"user_oss_bucket\\",\\n \\"Bucket\\": \\"oss-test-bucket\\",\\n \\"Path\\": \\"ice/dir\\",\\n \\"Status\\": \\"normal\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDefaultStorageLocationResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <StorageType>user_oss_bucket</StorageType>\\n <Bucket>oss-test-bucket</Bucket>\\n <Path>ice/dir</Path>\\n <Status>normal</Status>\\n</GetDefaultStorageLocationResponse>","errorExample":""}]', + 'title' => '获取默认存储位置', + ], + 'DescribePlayList' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146436', + 'abilityTreeNodes' => [ + 'FEATUREiceM55707', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'TraceId', + 'in' => 'query', + 'schema' => [ + 'description' => '播放器的TraceId。', + 'type' => 'string', + 'required' => false, + 'example' => '0bc5e70516766285805381012d271e', + ], + ], + [ + 'name' => 'BeginTs', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，默认查询当天的时间。', + 'type' => 'string', + 'required' => true, + 'example' => '1676170500011', + ], + ], + [ + 'name' => 'EndTs', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，不能超过24小时。', + 'type' => 'string', + 'required' => true, + 'example' => '1682474405173', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '排序类型。取值：'."\n" + .'- DESC：倒序 '."\n" + .'- ASC：正序', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderName', + 'in' => 'query', + 'schema' => [ + 'description' => '排序名称。取值：'."\n" + .'- FirstFrameDuration：首帧耗时'."\n" + .'- PlayDuration：播放时长'."\n" + .'- VideoDuration：视频时长'."\n" + .'- StuckDuration：卡顿时长', + 'type' => 'string', + 'required' => false, + 'example' => 'FirstFrameDuration', + ], + ], + [ + 'name' => 'PlayType', + 'in' => 'query', + 'schema' => [ + 'description' => '播放类型。取值：'."\n" + .'- vod：点播', + 'type' => 'string', + 'required' => false, + 'example' => 'vod', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '播放状态。取值：'."\n" + .'- complete：播放完成'."\n" + .'- playing：播放中'."\n" + .'- unusual：播放异常', + 'type' => 'string', + 'required' => false, + 'example' => 'complete', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => '总播放次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '49', + ], + 'RequestId' => [ + 'title' => 'Id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B960580D-26FA-5547-8AFC-3CDC812DBF27', + ], + 'PageNum' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。默认值20。最大值100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PlayList' => [ + 'description' => '播放记录列表', + 'type' => 'array', + 'items' => [ + 'description' => '播放记录', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '播放状态', + 'type' => 'string', + 'example' => 'complete', + ], + 'VideoId' => [ + 'description' => '视频ID', + 'type' => 'string', + 'example' => '250314203f0171eebff17035d0b20102', + ], + 'StuckDuration' => [ + 'description' => '卡顿时长', + 'type' => 'string', + 'example' => '20', + ], + 'PlayDuration' => [ + 'description' => '播放时长', + 'type' => 'string', + 'example' => '1000', + ], + 'FirstFrameDuration' => [ + 'description' => '首帧耗时', + 'type' => 'string', + 'example' => '200', + ], + 'TraceId' => [ + 'description' => '播放器TraceId', + 'type' => 'string', + 'example' => '0b736abf16724820210842673d9543', + ], + 'PlayType' => [ + 'description' => '播放类型', + 'type' => 'string', + 'example' => 'vod', + ], + 'SessionId' => [ + 'description' => '播放器会话ID', + 'type' => 'string', + 'example' => '91488be2-8381-40c9-8494-e8afe22c4a2d', + ], + 'VideoDuration' => [ + 'description' => '视频时长', + 'type' => 'string', + 'example' => '2000', + ], + 'PlayTs' => [ + 'description' => '启播时间戳', + 'type' => 'string', + 'example' => '1675922209572', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Meter.ParamError', + 'errorMessage' => 'Param Error:%s,Please Check Again.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Meter.AuthError', + 'errorMessage' => 'Authentication Failed,Please Try Again.', + ], + ], + 500 => [ + [ + 'errorCode' => 'Meter.ServerInternalError', + 'errorMessage' => 'The Request Processing Has Failed Due To Some Unknown Error.', + ], + [ + 'errorCode' => 'Meter.DataSourceQueryError', + 'errorMessage' => 'Data Source Error:%s,Please Try Again.', + ], + ], + 502 => [ + [ + 'errorCode' => 'Meter.ReadyTsError', + 'errorMessage' => 'Get ReadyTs Failed,Please Try Again.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalNum\\": 49,\\n \\"RequestId\\": \\"B960580D-26FA-5547-8AFC-3CDC812DBF27\\",\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"PlayList\\": [\\n {\\n \\"Status\\": \\"complete\\",\\n \\"VideoId\\": \\"250314203f0171eebff17035d0b20102\\",\\n \\"StuckDuration\\": \\"20\\",\\n \\"PlayDuration\\": \\"1000\\",\\n \\"FirstFrameDuration\\": \\"200\\",\\n \\"TraceId\\": \\"0b736abf16724820210842673d9543\\",\\n \\"PlayType\\": \\"vod\\",\\n \\"SessionId\\": \\"91488be2-8381-40c9-8494-e8afe22c4a2d\\",\\n \\"VideoDuration\\": \\"2000\\",\\n \\"PlayTs\\": \\"1675922209572\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '播放记录列表接口', + 'summary' => '通过播放器TraceId来获取播放记录列表，该接口有分页。', + 'responseParamsDescription' => '```'."\n" + .'{'."\n" + .' "code":"200",'."\n" + .' "data":{'."\n" + .' "PlayList":['."\n" + .' {'."\n" + .' "Status":"unusual",'."\n" + .' "PlayTs":1700533661526,'."\n" + .' "PlayDuration":0.0000,'."\n" + .' "VideoId":"11222223333",'."\n" + .' "VideoDuration":227285.0000,'."\n" + .' "PlayType":"vod",'."\n" + .' "TraceId":"1840527851",'."\n" + .' "SessionId":"c031504c-c43c-5628-a1b7-3cddddjhd34370",'."\n" + .' "FirstFrameDuration":220,'."\n" + .' "StuckDuration":0.0000'."\n" + .' }'."\n" + .' ],'."\n" + .' "TotalNum":1,'."\n" + .' "RequestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",'."\n" + .' "PageNum":1,'."\n" + .' "PageSize":1'."\n" + .' },'."\n" + .' "httpStatusCode":"200",'."\n" + .' "requestId":"54D95240-6BE7-1BCB-B8FB-27141AE6A5E6",'."\n" + .' "successResponse":true'."\n" + .'}'."\n" + .'```', + ], + 'AddFavoritePublicMedia' => [ + 'summary' => '根据输入的mediaId 列表，将所有媒资加入收藏。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'IMS媒资ID。'."\n" + .'- 多个用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'IgnoredList' => [ + 'type' => 'array', + 'items' => [ + 'description' => '没有收藏成功的ID。', + 'type' => 'string', + 'example' => 'icepublic-****7213c6050cbc66750b469701****', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<AddFavoritePublicMediaResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <IgnoredList>icepublic-****7213c6050cbc66750b469701****</IgnoredList>\\n</AddFavoritePublicMediaResponse>","errorExample":""}]', + 'title' => '收藏公共版权媒资', + ], + 'CancelFavoritePublicMedia' => [ + 'summary' => '根据输入的mediaId 列表，将所有媒资取消收藏。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'IMS媒资ID。'."\n" + .'- 多个用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'icepublic-****7213c6050cbc66750b469701****,icepublic-****0b4697017213c6050cbc6675****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'IgnoredList' => [ + 'description' => '取消收藏不成功的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '取消收藏不成功的ID列表。', + 'type' => 'string', + 'example' => 'icepublic-****7213c6050cbc66750b469701****', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"IgnoredList\\": [\\n \\"icepublic-****7213c6050cbc66750b469701****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CancelFavoritePublicMediaResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <IgnoredList>icepublic-****7213c6050cbc66750b469701****</IgnoredList>\\n</CancelFavoritePublicMediaResponse>","errorExample":""}]', + 'title' => '取消收藏公共版权媒资', + ], + 'GetPublicMediaInfo' => [ + 'summary' => '根据ICE公共版权媒资的 mediaId，获取并返回媒资信息。接口返回的URL为版权媒资的试听或试看地址，合成时会使用正式素材。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '104901', + 'abilityTreeNodes' => [ + 'FEATUREiceFEJXOS', + ], + ], + 'parameters' => [ + [ + 'name' => 'MediaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IMS媒资ID', + 'type' => 'string', + 'required' => false, + 'example' => 'icepublic-****14e501538aeef0a3140176f6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'MediaInfo' => [ + 'description' => '媒资信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => 'icepublic-****14e501538aeef0a3140176f6****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => 'BasicInfo', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => 'MediaId', + 'type' => 'string', + 'example' => 'icepublic-****14e501538aeef0a3140176f6****', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型', + 'type' => 'string', + 'example' => 'video', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => 'title', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => 'description', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => 'category', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => '标签,tag1', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => '{"key":"value"}', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:08Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:10Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2020-12-26T04:11:15Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + ], + ], + 'DynamicMetaData' => [ + 'title' => '公共媒资动态元数据', + 'description' => '公共媒资动态元数据', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '类型。取值范围：'."\n" + ."\n" + .'- "ai": AI原始结果统一化处理后的AI数据'."\n" + .'- "user-defined": 用户自定义元数据'."\n" + .'- "system": 系统自带', + 'type' => 'string', + 'example' => 'system', + ], + 'Data' => [ + 'title' => '元数据json', + 'description' => '元数据json', + 'type' => 'string', + 'example' => '{"AuditionUrl": "http://example-bucket.cdn.domain.com/example.mp4", "AuditionCount": 3}', + ], + ], + ], + 'FileInfoList' => [ + 'title' => 'FileInfos', + 'description' => 'FileInfos', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileBasicInfo' => [ + 'title' => '文件基础信息，包含时长，大小等', + 'description' => '文件基础信息，包含时长，大小等', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '文件名', + 'description' => '文件名', + 'type' => 'string', + 'example' => 'example.mp4', + ], + 'FileStatus' => [ + 'title' => '文件状态', + 'description' => '文件状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'FileType' => [ + 'title' => '文件类型', + 'description' => '文件类型', + 'type' => 'string', + 'example' => 'source_file', + ], + 'FileSize' => [ + 'title' => '文件大小（字节）', + 'description' => '文件大小（字节）', + 'type' => 'string', + 'example' => '27007', + ], + 'FileUrl' => [ + 'title' => '文件oss地址', + 'description' => '版权媒资试听或试看地址。', + 'type' => 'string', + 'example' => 'http://example-bucket.cdn.domain.com/example.mp4', + ], + 'Region' => [ + 'title' => '文件存储区域', + 'description' => '文件存储区域', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'FormatName' => [ + 'title' => '封装格式', + 'description' => '封装格式', + 'type' => 'string', + 'example' => 'mp4', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '16.2', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '192.0', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '0', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'AudioStreamInfoList' => [ + 'title' => '音频流信息，一个媒资可能有多条音频流', + 'description' => '音频流信息，一个媒资可能有多条音频流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '音频流序号', + 'description' => '音频流序号', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'aac', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'AAC (Advanced Audio Coding)', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '1/44100', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => 'mp4a', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => '0x6134706d', + ], + 'Profile' => [ + 'title' => '编码预置', + 'description' => '编码预置', + 'type' => 'string', + 'example' => 'High', + ], + 'SampleFmt' => [ + 'title' => '采样格式', + 'description' => '采样格式', + 'type' => 'string', + 'example' => 'fltp', + ], + 'SampleRate' => [ + 'title' => '采样率', + 'description' => '采样率', + 'type' => 'string', + 'example' => '44100', + ], + 'Channels' => [ + 'title' => '声道数', + 'description' => '声道数', + 'type' => 'string', + 'example' => '2', + ], + 'ChannelLayout' => [ + 'title' => '声道输出样式', + 'description' => '声道输出样式', + 'type' => 'string', + 'example' => 'stereo', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '1/44100', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0.000000', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '16.2', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '192.0', + ], + 'Fps' => [ + 'title' => '音频帧率', + 'description' => '音频帧率', + 'type' => 'string', + 'example' => '10', + ], + 'NumFrames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '162', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + ], + ], + ], + 'VideoStreamInfoList' => [ + 'title' => '视频流信息，一个媒资可能有多条视频流', + 'description' => '视频流信息，一个媒资可能有多条视频流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '视频流序号', + 'description' => '视频流序号', + 'type' => 'string', + 'example' => '0', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'h264', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10', + ], + 'Profile' => [ + 'title' => '编码预置', + 'description' => '编码预置', + 'type' => 'string', + 'example' => 'High', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '1/48', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => '[0][0][0][0]', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => '0x0000', + ], + 'Width' => [ + 'title' => '宽', + 'description' => '宽', + 'type' => 'string', + 'example' => '960', + ], + 'Height' => [ + 'title' => '高', + 'description' => '高', + 'type' => 'string', + 'example' => '540', + ], + 'HasBFrames' => [ + 'title' => '是否有B帧', + 'description' => '是否有B帧', + 'type' => 'string', + 'example' => '2', + ], + 'Sar' => [ + 'title' => '编码信号分辨率比', + 'description' => '编码信号分辨率比', + 'type' => 'string', + 'example' => '0:1', + ], + 'Dar' => [ + 'title' => '编码显示分辨率比', + 'description' => '编码显示分辨率比', + 'type' => 'string', + 'example' => '0:1', + ], + 'PixFmt' => [ + 'title' => '像素格式', + 'description' => '像素格式', + 'type' => 'string', + 'example' => 'yuv420p', + ], + 'Level' => [ + 'title' => '编码等级', + 'description' => '编码等级', + 'type' => 'string', + 'example' => '30', + ], + 'Fps' => [ + 'title' => '视频帧率', + 'description' => '视频帧率', + 'type' => 'string', + 'example' => '24.0', + ], + 'AvgFPS' => [ + 'title' => '平均帧率', + 'description' => '平均帧率', + 'type' => 'string', + 'example' => '24.0', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '1/12288', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0.081706', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '216.206706', + ], + 'Bitrate' => [ + 'title' => '码率', + 'description' => '码率', + 'type' => 'string', + 'example' => '1001.594', + ], + 'NumFrames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '5184', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + 'Rotate' => [ + 'title' => '旋转', + 'description' => '旋转', + 'type' => 'string', + 'example' => '0', + ], + 'Nb_frames' => [ + 'title' => '总帧数', + 'description' => '总帧数', + 'type' => 'string', + 'example' => '5184', + ], + ], + ], + ], + 'SubtitleStreamInfoList' => [ + 'title' => '字幕流信息，一个媒资可能有多条字幕流', + 'description' => '字幕流信息，一个媒资可能有多条字幕流', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '音频流序号', + 'description' => '字幕流序号', + 'type' => 'string', + 'example' => '1', + ], + 'CodecName' => [ + 'title' => '编码格式简述名', + 'description' => '编码格式简述名', + 'type' => 'string', + 'example' => 'srt', + ], + 'CodecLongName' => [ + 'title' => '编码格式长述名', + 'description' => '编码格式长述名', + 'type' => 'string', + 'example' => 'SubRip Text', + ], + 'CodecTimeBase' => [ + 'title' => '编码时基', + 'description' => '编码时基', + 'type' => 'string', + 'example' => '29.97', + ], + 'CodecTagString' => [ + 'title' => '编码格式标记文本', + 'description' => '编码格式标记文本', + 'type' => 'string', + 'example' => 'unicode', + ], + 'CodecTag' => [ + 'title' => '编码格式标记', + 'description' => '编码格式标记', + 'type' => 'string', + 'example' => 'unicode', + ], + 'Timebase' => [ + 'title' => '时基', + 'description' => '时基', + 'type' => 'string', + 'example' => '30', + ], + 'StartTime' => [ + 'title' => '起始时间', + 'description' => '起始时间', + 'type' => 'string', + 'example' => '0', + ], + 'Duration' => [ + 'title' => '时长', + 'description' => '时长', + 'type' => 'string', + 'example' => '1', + ], + 'Lang' => [ + 'title' => '语言', + 'description' => '语言', + 'type' => 'string', + 'example' => 'und', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"icepublic-****14e501538aeef0a3140176f6****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"icepublic-****14e501538aeef0a3140176f6****\\",\\n \\"MediaType\\": \\"video\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"标签,tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T04:11:08Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T04:11:10Z\\",\\n \\"DeletedTime\\": \\"2020-12-26T04:11:15Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\"\\n },\\n \\"DynamicMetaData\\": {\\n \\"Type\\": \\"system\\",\\n \\"Data\\": \\"{\\\\\\"AuditionUrl\\\\\\": \\\\\\"http://example-bucket.cdn.domain.com/example.mp4\\\\\\", \\\\\\"AuditionCount\\\\\\": 3}\\"\\n },\\n \\"FileInfoList\\": [\\n {\\n \\"FileBasicInfo\\": {\\n \\"FileName\\": \\"example.mp4\\",\\n \\"FileStatus\\": \\"Normal\\",\\n \\"FileType\\": \\"source_file\\",\\n \\"FileSize\\": \\"27007\\",\\n \\"FileUrl\\": \\"http://example-bucket.cdn.domain.com/example.mp4\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"FormatName\\": \\"mp4\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"192.0\\",\\n \\"Width\\": \\"0\\",\\n \\"Height\\": \\"0\\"\\n },\\n \\"AudioStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"aac\\",\\n \\"CodecLongName\\": \\"AAC (Advanced Audio Coding)\\",\\n \\"CodecTimeBase\\": \\"1/44100\\",\\n \\"CodecTagString\\": \\"mp4a\\",\\n \\"CodecTag\\": \\"0x6134706d\\",\\n \\"Profile\\": \\"High\\",\\n \\"SampleFmt\\": \\"fltp\\",\\n \\"SampleRate\\": \\"44100\\",\\n \\"Channels\\": \\"2\\",\\n \\"ChannelLayout\\": \\"stereo\\",\\n \\"Timebase\\": \\"1/44100\\",\\n \\"StartTime\\": \\"0.000000\\",\\n \\"Duration\\": \\"16.2\\",\\n \\"Bitrate\\": \\"192.0\\",\\n \\"Fps\\": \\"10\\",\\n \\"NumFrames\\": \\"162\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ],\\n \\"VideoStreamInfoList\\": [\\n {\\n \\"Index\\": \\"0\\",\\n \\"CodecName\\": \\"h264\\",\\n \\"CodecLongName\\": \\"H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10\\",\\n \\"Profile\\": \\"High\\",\\n \\"CodecTimeBase\\": \\"1/48\\",\\n \\"CodecTagString\\": \\"[0][0][0][0]\\",\\n \\"CodecTag\\": \\"0x0000\\",\\n \\"Width\\": \\"960\\",\\n \\"Height\\": \\"540\\",\\n \\"HasBFrames\\": \\"2\\",\\n \\"Sar\\": \\"0:1\\",\\n \\"Dar\\": \\"0:1\\",\\n \\"PixFmt\\": \\"yuv420p\\",\\n \\"Level\\": \\"30\\",\\n \\"Fps\\": \\"24.0\\",\\n \\"AvgFPS\\": \\"24.0\\",\\n \\"Timebase\\": \\"1/12288\\",\\n \\"StartTime\\": \\"0.081706\\",\\n \\"Duration\\": \\"216.206706\\",\\n \\"Bitrate\\": \\"1001.594\\",\\n \\"NumFrames\\": \\"5184\\",\\n \\"Lang\\": \\"und\\",\\n \\"Rotate\\": \\"0\\",\\n \\"Nb_frames\\": \\"5184\\"\\n }\\n ],\\n \\"SubtitleStreamInfoList\\": [\\n {\\n \\"Index\\": \\"1\\",\\n \\"CodecName\\": \\"srt\\",\\n \\"CodecLongName\\": \\"SubRip Text\\",\\n \\"CodecTimeBase\\": \\"29.97\\",\\n \\"CodecTagString\\": \\"unicode\\",\\n \\"CodecTag\\": \\"unicode\\",\\n \\"Timebase\\": \\"30\\",\\n \\"StartTime\\": \\"0\\",\\n \\"Duration\\": \\"1\\",\\n \\"Lang\\": \\"und\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPublicMediaInfoResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <MediaInfo>\\n <MediaId>icepublic-****14e501538aeef0a3140176f6****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>icepublic-****14e501538aeef0a3140176f6****</MediaId>\\n <MediaType>video</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>title</Title>\\n <Description>description</Description>\\n <Category>category</Category>\\n <MediaTags>标签,tag1</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>{\\"key\\":\\"value\\"}</UserData>\\n <Status>Normal</Status>\\n <CreateTime>2020-12-26T04:11:08Z</CreateTime>\\n <ModifiedTime>2020-12-26T04:11:10Z</ModifiedTime>\\n <DeletedTime>2020-12-26T04:11:15Z</DeletedTime>\\n <SpriteImages>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"32\\",\\"iceJobId\\":\\"******83ec44d58b2069def2e******\\",\\"location\\":\\"oss-cn-shanghai\\",\\"snapshotRegular\\":\\"example/example-{Count}.jpg\\",\\"spriteRegular\\":\\"example/example-{TileCount}.jpg\\",\\"templateId\\":\\"******e438b14ff39293eaec25******\\",\\"tileCount\\":\\"1\\"}]</SpriteImages>\\n </MediaBasicInfo>\\n <DynamicMetaData>\\n <Type>system</Type>\\n <Data>{\\"AuditionUrl\\": \\"http://example-bucket.cdn.domain.com/example.mp4\\", \\"AuditionCount\\": 3}</Data>\\n </DynamicMetaData>\\n <FileInfoList>\\n <FileBasicInfo>\\n <FileName>example.mp4</FileName>\\n <FileStatus>Normal</FileStatus>\\n <FileType>source_file</FileType>\\n <FileSize>27007</FileSize>\\n <FileUrl>http://example-bucket.cdn.domain.com/example.mp4</FileUrl>\\n <Region>cn-shanghai</Region>\\n <FormatName>mp4</FormatName>\\n <Duration>16.2</Duration>\\n <Bitrate>192.0</Bitrate>\\n <Width>0</Width>\\n <Height>0</Height>\\n </FileBasicInfo>\\n <AudioStreamInfoList>\\n <Index>1</Index>\\n <CodecName>aac</CodecName>\\n <CodecLongName>AAC (Advanced Audio Coding)</CodecLongName>\\n <CodecTimeBase>1/44100</CodecTimeBase>\\n <CodecTagString>mp4a</CodecTagString>\\n <CodecTag>0x6134706d</CodecTag>\\n <Profile>High</Profile>\\n <SampleFmt>fltp</SampleFmt>\\n <SampleRate>44100</SampleRate>\\n <Channels>2</Channels>\\n <ChannelLayout>stereo</ChannelLayout>\\n <Timebase>1/44100</Timebase>\\n <StartTime>0.000000</StartTime>\\n <Duration>16.2</Duration>\\n <Bitrate>192.0</Bitrate>\\n <Fps>10</Fps>\\n <NumFrames>162</NumFrames>\\n <Lang>und</Lang>\\n </AudioStreamInfoList>\\n <VideoStreamInfoList>\\n <Index>0</Index>\\n <CodecName>h264</CodecName>\\n <CodecLongName>H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</CodecLongName>\\n <Profile>High</Profile>\\n <CodecTimeBase>1/48</CodecTimeBase>\\n <CodecTagString>[0][0][0][0]</CodecTagString>\\n <CodecTag>0x0000</CodecTag>\\n <Width>960</Width>\\n <Height>540</Height>\\n <HasBFrames>2</HasBFrames>\\n <Sar>0:1</Sar>\\n <Dar>0:1</Dar>\\n <PixFmt>yuv420p</PixFmt>\\n <Level>30</Level>\\n <Fps>24.0</Fps>\\n <AvgFPS>24.0</AvgFPS>\\n <Timebase>1/12288</Timebase>\\n <StartTime>0.081706</StartTime>\\n <Duration>216.206706</Duration>\\n <Bitrate>1001.594</Bitrate>\\n <NumFrames>5184</NumFrames>\\n <Lang>und</Lang>\\n <Rotate>0</Rotate>\\n <Nb_frames>5184</Nb_frames>\\n </VideoStreamInfoList>\\n <SubtitleStreamInfoList>\\n <Index>1</Index>\\n <CodecName>srt</CodecName>\\n <CodecLongName>SubRip Text</CodecLongName>\\n <CodecTimeBase>29.97</CodecTimeBase>\\n <CodecTagString>unicode</CodecTagString>\\n <CodecTag>unicode</CodecTag>\\n <Timebase>30</Timebase>\\n <StartTime>0</StartTime>\\n <Duration>1</Duration>\\n <Lang>und</Lang>\\n </SubtitleStreamInfoList>\\n </FileInfoList>\\n </MediaInfo>\\n</GetPublicMediaInfoResponse>","errorExample":""}]', + 'title' => '获取公共版权媒资', + ], + 'SearchPublicMediaInfo' => [ + 'summary' => '根据用户所给参数，搜索符合条件的媒资。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'MediaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'IMS媒资ID。'."\n" + .'- 多个用英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '****20b48fb04483915d4f2cd8ac****,****15d4a4b0448391508f2cb486****', + ], + ], + [ + 'name' => 'DynamicMetaDataMatchFields', + 'in' => 'query', + 'schema' => [ + 'description' => '动态元数据搜索匹配条件', + 'type' => 'string', + 'required' => false, + 'example' => '"ApprovalStatus=\'Available\'&MaterialBags=\'boutiquemusic\'&Mood=\'Nervous\'"', + ], + ], + [ + 'name' => 'Favorite', + 'in' => 'query', + 'schema' => [ + 'description' => '用户是否收藏了该媒资。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Authorized', + 'in' => 'query', + 'schema' => [ + 'description' => '用户是否已购买了包含此媒资的资源包。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '结果排序方式 <field>:<order>。取值范围：'."\n" + ."\n" + .'field:'."\n" + .'- "UsageCount" 使用量'."\n" + .'- "UnitPrice" 单价'."\n" + ."\n" + .'order:'."\n" + .'- "Desc" 倒序'."\n" + .'- "Asc" 正序', + 'type' => 'string', + 'required' => false, + 'example' => 'UsageCount:Desc,UnitPrice:Asc', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页行数大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID，用来标识不同种类的公共版权媒资。取值：'."\n" + .'- Copyright_Music: 公共版权音乐', + 'type' => 'string', + 'required' => false, + 'example' => 'Copyright_Music', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****3CFB-2767-54FD-B311-BD15A4C1****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PublicMediaInfos' => [ + 'description' => '公共版权媒资信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Authorized' => [ + 'description' => '是否已购买包含该媒资的资源包。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Favorite' => [ + 'description' => '是否收藏了该媒资。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RemainingAuthTime' => [ + 'description' => '资源包剩余有效时间（天）', + 'type' => 'string', + 'example' => '100', + ], + 'MediaInfo' => [ + 'description' => '媒资信息', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => '媒资ID', + 'description' => '媒资ID', + 'type' => 'string', + 'example' => 'icepublic-****87b921bb4a55908a72a0537e****', + ], + 'MediaBasicInfo' => [ + 'title' => 'BasicInfo', + 'description' => 'BasicInfo', + 'type' => 'object', + 'properties' => [ + 'MediaId' => [ + 'title' => 'MediaId', + 'description' => 'MediaId', + 'type' => 'string', + 'example' => 'icepublic-****87b921bb4a55908a72a0537e****', + ], + 'MediaType' => [ + 'title' => '媒资媒体类型', + 'description' => '媒资媒体类型', + 'type' => 'string', + 'example' => 'audio', + ], + 'BusinessType' => [ + 'title' => '媒资业务类型', + 'description' => '媒资业务类型', + 'type' => 'string', + 'example' => 'general', + ], + 'Source' => [ + 'title' => '来源', + 'description' => '来源', + 'type' => 'string', + 'example' => 'oss', + ], + 'Title' => [ + 'title' => '标题', + 'description' => '标题', + 'type' => 'string', + 'example' => 'title', + ], + 'Description' => [ + 'title' => '内容描述', + 'description' => '内容描述', + 'type' => 'string', + 'example' => 'description', + ], + 'Category' => [ + 'title' => '分类', + 'description' => '分类', + 'type' => 'string', + 'example' => 'category', + ], + 'MediaTags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => '标签,tag1', + ], + 'CoverURL' => [ + 'title' => '封面地址', + 'description' => '封面地址', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>', + ], + 'UserData' => [ + 'title' => '用户数据', + 'description' => '用户数据', + 'type' => 'string', + 'example' => 'userDataTest', + ], + 'Status' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreateTime' => [ + 'title' => '媒资创建时间', + 'description' => '媒资创建时间', + 'type' => 'string', + 'example' => '2020-12-26T06:04:49Z', + ], + 'ModifiedTime' => [ + 'title' => '媒资修改时间', + 'description' => '媒资修改时间', + 'type' => 'string', + 'example' => '2020-12-26T06:04:50Z', + ], + 'DeletedTime' => [ + 'title' => '媒资删除时间', + 'description' => '媒资删除时间', + 'type' => 'string', + 'example' => '2020-12-29T06:04:49Z', + ], + 'SpriteImages' => [ + 'title' => '雪碧图', + 'description' => '雪碧图', + 'type' => 'string', + 'example' => '[{"bucket":"example-bucket","count":"32","iceJobId":"******83ec44d58b2069def2e******","location":"oss-cn-shanghai","snapshotRegular":"example/example-{Count}.jpg","spriteRegular":"example/example-{TileCount}.jpg","templateId":"******e438b14ff39293eaec25******","tileCount":"1"}]', + ], + ], + ], + 'DynamicMetaData' => [ + 'description' => '动态元数据', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '元数据json string', + 'type' => 'string', + 'example' => '"{\\"AuditionUrl\\": \\"http://xxx\\", \\"AuditionCount\\": 3...}"', + ], + 'Type' => [ + 'description' => '类型。取值范围：'."\n" + ."\n" + .'- "ai": AI原始结果统一化处理后的AI数据'."\n" + .'- "user-defined": 用户自定义元数据'."\n" + .'- "system": 系统自带'."\n", + 'type' => 'string', + 'example' => 'system', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****3CFB-2767-54FD-B311-BD15A4C1****\\",\\n \\"TotalCount\\": 100,\\n \\"PublicMediaInfos\\": [\\n {\\n \\"Authorized\\": true,\\n \\"Favorite\\": true,\\n \\"RemainingAuthTime\\": \\"100\\",\\n \\"MediaInfo\\": {\\n \\"MediaId\\": \\"icepublic-****87b921bb4a55908a72a0537e****\\",\\n \\"MediaBasicInfo\\": {\\n \\"MediaId\\": \\"icepublic-****87b921bb4a55908a72a0537e****\\",\\n \\"MediaType\\": \\"audio\\",\\n \\"BusinessType\\": \\"general\\",\\n \\"Source\\": \\"oss\\",\\n \\"Title\\": \\"title\\",\\n \\"Description\\": \\"description\\",\\n \\"Category\\": \\"category\\",\\n \\"MediaTags\\": \\"标签,tag1\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken>\\",\\n \\"UserData\\": \\"userDataTest\\",\\n \\"Status\\": \\"Normal\\",\\n \\"CreateTime\\": \\"2020-12-26T06:04:49Z\\",\\n \\"ModifiedTime\\": \\"2020-12-26T06:04:50Z\\",\\n \\"DeletedTime\\": \\"2020-12-29T06:04:49Z\\",\\n \\"SpriteImages\\": \\"[{\\\\\\"bucket\\\\\\":\\\\\\"example-bucket\\\\\\",\\\\\\"count\\\\\\":\\\\\\"32\\\\\\",\\\\\\"iceJobId\\\\\\":\\\\\\"******83ec44d58b2069def2e******\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"snapshotRegular\\\\\\":\\\\\\"example/example-{Count}.jpg\\\\\\",\\\\\\"spriteRegular\\\\\\":\\\\\\"example/example-{TileCount}.jpg\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"******e438b14ff39293eaec25******\\\\\\",\\\\\\"tileCount\\\\\\":\\\\\\"1\\\\\\"}]\\"\\n },\\n \\"DynamicMetaData\\": {\\n \\"Data\\": \\"\\\\\\"{\\\\\\\\\\\\\\"AuditionUrl\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://xxx\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"AuditionCount\\\\\\\\\\\\\\": 3...}\\\\\\"\\",\\n \\"Type\\": \\"system\\"\\n }\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchPublicMediaInfoResponse>\\n <RequestId>****3CFB-2767-54FD-B311-BD15A4C1****</RequestId>\\n <TotalCount>100</TotalCount>\\n <PublicMediaInfos>\\n <Authorized>true</Authorized>\\n <Favorite>true</Favorite>\\n <RemainingAuthTime>100</RemainingAuthTime>\\n <MediaInfo>\\n <MediaId>icepublic-****87b921bb4a55908a72a0537e****</MediaId>\\n <MediaBasicInfo>\\n <MediaId>icepublic-****87b921bb4a55908a72a0537e****</MediaId>\\n <MediaType>audio</MediaType>\\n <BusinessType>general</BusinessType>\\n <Source>oss</Source>\\n <Title>title</Title>\\n <Description>description</Description>\\n <Category>category</Category>\\n <MediaTags>标签,tag1</MediaTags>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=<ExpireTime>&OSSAccessKeyId=<OSSAccessKeyId>&Signature=<Signature>&security-token=<SecurityToken></CoverURL>\\n <UserData>userDataTest</UserData>\\n <Status>Normal</Status>\\n <CreateTime>2020-12-26T06:04:49Z</CreateTime>\\n <ModifiedTime>2020-12-26T06:04:50Z</ModifiedTime>\\n <DeletedTime>2020-12-29T06:04:49Z</DeletedTime>\\n <SpriteImages>[{\\"bucket\\":\\"example-bucket\\",\\"count\\":\\"32\\",\\"iceJobId\\":\\"******83ec44d58b2069def2e******\\",\\"location\\":\\"oss-cn-shanghai\\",\\"snapshotRegular\\":\\"example/example-{Count}.jpg\\",\\"spriteRegular\\":\\"example/example-{TileCount}.jpg\\",\\"templateId\\":\\"******e438b14ff39293eaec25******\\",\\"tileCount\\":\\"1\\"}]</SpriteImages>\\n </MediaBasicInfo>\\n <DynamicMetaData>\\n <Data>\\"{\\\\\\"AuditionUrl\\\\\\": \\\\\\"http://xxx\\\\\\", \\\\\\"AuditionCount\\\\\\": 3...}\\"</Data>\\n <Type>system</Type>\\n </DynamicMetaData>\\n </MediaInfo>\\n </PublicMediaInfos>\\n</SearchPublicMediaInfoResponse>","errorExample":""}]', + 'title' => '搜索公共版权媒资', + ], + 'GetStorageList' => [ + 'summary' => '获取存储配置列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用Id', + 'type' => 'string', + 'required' => false, + 'example' => 'app-****', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'description' => '存储类型', + 'type' => 'string', + 'required' => false, + 'example' => 'vod_oss_bucket', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS存储状态', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '******73-8B78-5D86-A50C-49B96C******', + ], + 'StorageInfoList' => [ + 'description' => '存储配置列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => '应用Id', + 'type' => 'string', + 'example' => 'app-****', + ], + 'StorageLocation' => [ + 'description' => 'OSS存储', + 'type' => 'string', + 'example' => 'your-bucket', + ], + 'Path' => [ + 'description' => 'OSS路径', + 'type' => 'string', + 'example' => 'your-path/', + ], + 'StorageType' => [ + 'description' => '存储类型', + 'type' => 'string', + 'example' => 'vod_oss_bucket', + ], + 'Status' => [ + 'description' => 'OSS存储状态', + 'type' => 'string', + 'example' => 'Normal', + ], + 'DefaultStorage' => [ + 'description' => '是否为默认存储', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EditingTempFileStorage' => [ + 'description' => '是否为剪辑默认存储', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreationTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-06-06T01:55:07Z', + ], + 'ModifiedTime' => [ + 'description' => '最后修改时间', + 'type' => 'string', + 'example' => '2024-06-06T03:07:07Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******73-8B78-5D86-A50C-49B96C******\\",\\n \\"StorageInfoList\\": [\\n {\\n \\"AppId\\": \\"app-****\\",\\n \\"StorageLocation\\": \\"your-bucket\\",\\n \\"Path\\": \\"your-path/\\",\\n \\"StorageType\\": \\"vod_oss_bucket\\",\\n \\"Status\\": \\"Normal\\",\\n \\"DefaultStorage\\": true,\\n \\"EditingTempFileStorage\\": false,\\n \\"CreationTime\\": \\"2024-06-06T01:55:07Z\\",\\n \\"ModifiedTime\\": \\"2024-06-06T03:07:07Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取OSS存储地址列表', + ], + 'SearchEditingProject' => [ + 'summary' => '支持按创建时间、状态搜索。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'CreateTime（创建时间）的开始时间', + 'description' => 'CreationTime（创建时间）的开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'CreationTime（创建时间）的结束时间', + 'description' => 'CreationTime（创建时间）的结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '2017-01-11T12:00:00Z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '云剪辑工程状态。多个用逗号分隔', + 'description' => '云剪辑工程状态。多个用英文逗号（,）分隔。默认获取所有云剪辑工程。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'\\-Draft：草稿。'."\n" + ."\n" + .'\\-Producing：合成中。'."\n" + ."\n" + .'\\-Produced：合成成功。'."\n" + ."\n" + .'\\-ProduceFailed：合成失败。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Draft' => '草稿', + 'Produced' => '合成成功', + 'Producing' => '合成中', + 'ProduceFailed' => '合成失败', + ], + 'example' => 'Producing', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '结果排序方式', + 'description' => '结果排序方式。取值范围：'."\n" + ."\n" + .'\\-CreationTime:Desc（默认值）：按创建时间倒序。'."\n" + ."\n" + .'\\-CreationTime:Asc：按创建时间升序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreationTime:Asc' => '按创建时间升序', + 'CreationTime:Desc' => '按创建时间倒序', + ], + 'example' => 'CreationTime:Desc', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数', + 'description' => '分页的页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数', + 'description' => '分页大小，每页显示条数。默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CreateSource', + 'in' => 'query', + 'schema' => [ + 'title' => '创建来源', + 'description' => '创建来源：'."\n" + ."\n" + .'\\-OpenAPI'."\n" + ."\n" + .'\\-AliyunConsole'."\n" + ."\n" + .'\\-WebSDK', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'WebSDK', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型：'."\n" + ."\n" + .'\\-Timeline'."\n" + ."\n" + .'\\-VETemplate', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Timeline' => '普通模板', + 'VETemplate' => '高级模板', + 'None' => '未使用模板', + ], + 'example' => 'Timeline', + ], + ], + [ + 'name' => 'ProjectType', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑工程类型，默认EditingProject'."\n" + ."\n" + .'- EditingProject: 普通剪辑工程'."\n" + ."\n" + .'- LiveEditingProject: 直播剪辑工程', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LiveEditingProject' => '直播剪辑工程', + 'EditingProject' => '普通剪辑工程', + ], + 'example' => 'EditingProject', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '****9262E3DA-07FA-4862-FCBB6BC61D08*****', + ], + 'ProjectList' => [ + 'title' => '云剪辑工程列表', + 'description' => '云剪辑工程列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '云剪辑工程ID', + 'description' => '云剪辑工程ID。', + 'type' => 'string', + 'example' => '****fddd7748b58bf1d47e95****', + ], + 'Title' => [ + 'title' => '云剪辑工程标题', + 'description' => '云剪辑工程标题。', + 'type' => 'string', + 'example' => 'title', + ], + 'Timeline' => [ + 'title' => '云剪辑工程时间线', + 'description' => '云剪辑工程时间线。', + 'type' => 'string', + 'example' => '{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}', + ], + 'Description' => [ + 'title' => '云剪辑工程描述', + 'description' => '云剪辑工程描述。', + 'type' => 'string', + 'example' => 'sample description', + ], + 'CoverURL' => [ + 'title' => '云剪辑工程封面', + 'description' => '云剪辑工程封面。', + 'type' => 'string', + 'example' => 'http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg', + ], + 'CreateTime' => [ + 'title' => '云剪辑工程创建时间', + 'description' => '云剪辑工程创建时间。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'ModifiedTime' => [ + 'title' => '云剪辑工程最新修改时间', + 'description' => '云剪辑工程最新修改时间。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'Duration' => [ + 'title' => '云剪辑工程总时长', + 'description' => '云剪辑工程总时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30.100000', + ], + 'Status' => [ + 'title' => '云剪辑工程状态', + 'description' => '所有云剪辑工程状态列表：'."\n" + ."\n" + .'\\-Draft'."\n" + ."\n" + .'\\-Editing'."\n" + ."\n" + .'\\-Producing'."\n" + ."\n" + .'\\-Produced'."\n" + ."\n" + .'\\-ProduceFailed', + 'type' => 'string', + 'enumValueTitles' => [ + 'Draft' => '草稿', + 'Produced' => '合成完成', + 'Editing' => '编辑中', + 'Producing' => '合成中', + 'ProduceFailed' => '合成失败', + ], + 'example' => 'PRODUCE_FAILED', + ], + 'ErrorCode' => [ + 'title' => '云剪辑工程合成失败的错误码', + 'description' => '云剪辑工程合成失败的错误码。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'ErrorMessage' => [ + 'title' => '云剪辑工程合成失败的消息', + 'description' => '云剪辑工程合成失败的消息。', + 'type' => 'string', + 'example' => '"EventTime":"2021-08-12T10:04:15Z","ErrorCode":"InvalidParameter","ErrorMessage":"The specified parameter \\"LiveStreamConfig\\" is not valid. specified parameter example is not valid.', + ], + 'CreateSource' => [ + 'title' => '创建来源', + 'description' => '云剪辑工程编辑方式：'."\n" + ."\n" + .'\\-OpenAPI'."\n" + ."\n" + .'\\-AliyunConsole'."\n" + ."\n" + .'\\-WebSDK', + 'type' => 'string', + 'enumValueTitles' => [ + 'AliyunConsole' => '通过阿里云控制台创建', + 'WebSDK' => '通过WebSDK创建', + 'OpenAPI' => '通过OpenAPI创建', + ], + 'example' => 'OpenAPI', + ], + 'ModifiedSource' => [ + 'title' => '最后一次修改来源', + 'description' => '最后一次修改来源。', + 'type' => 'string', + 'example' => '2017-01-11T12:00:00Z', + ], + 'TemplateType' => [ + 'title' => '模板类型', + 'description' => '模板类型。', + 'type' => 'string', + 'example' => 'Timeline', + ], + 'ProjectType' => [ + 'description' => '剪辑工程类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LiveEditingProject' => '直播剪辑工程', + 'EditingProject' => '普通剪辑工程', + ], + 'example' => 'EditingProject', + ], + 'BusinessConfig' => [ + 'description' => '工程业务配置，一般剪辑工程可忽略。', + 'type' => 'string', + 'example' => '{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }', + ], + 'BusinessStatus' => [ + 'description' => '工程业务状态，一般剪辑工程可忽略', + 'type' => 'string', + 'enumValueTitles' => [ + 'BroadCasting' => '直播中', + 'ReservationCanceled' => '预约取消', + 'LiveFinished' => '直播结束', + 'LoadingFailed' => '加载失败', + 'Reserving' => '预约中', + ], + 'example' => 'Reserving', + ], + ], + ], + ], + 'MaxResults' => [ + 'title' => '云剪辑工程总数', + 'description' => '本次请求所返回的最大记录条数，最后一页前每页记录条数为MaxResults取值。'."\n" + ."\n" + .'例如：'."\n" + ."\n" + .'正例：10,10,5，反例：10,5,10', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量，此参数为可选参数，默认可不返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '110', + ], + 'NextToken' => [ + 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"****9262E3DA-07FA-4862-FCBB6BC61D08*****\\",\\n \\"ProjectList\\": [\\n {\\n \\"ProjectId\\": \\"****fddd7748b58bf1d47e95****\\",\\n \\"Title\\": \\"title\\",\\n \\"Timeline\\": \\"{\\\\\\"VideoTracks\\\\\\":[{\\\\\\"VideoTrackClips\\\\\\":[{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"},{\\\\\\"MediaId\\\\\\":\\\\\\"****4d7cf14dc7b83b0e801c****\\\\\\"}]}]}\\",\\n \\"Description\\": \\"sample description\\",\\n \\"CoverURL\\": \\"http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg\\",\\n \\"CreateTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"ModifiedTime\\": \\"2017-01-11T12:00:00Z\\",\\n \\"Duration\\": 30.1,\\n \\"Status\\": \\"PRODUCE_FAILED\\",\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"\\\\\\"EventTime\\\\\\":\\\\\\"2021-08-12T10:04:15Z\\\\\\",\\\\\\"ErrorCode\\\\\\":\\\\\\"InvalidParameter\\\\\\",\\\\\\"ErrorMessage\\\\\\":\\\\\\"The specified parameter \\\\\\\\\\\\\\"LiveStreamConfig\\\\\\\\\\\\\\" is not valid. specified parameter example is not valid.\\",\\n \\"CreateSource\\": \\"OpenAPI\\",\\n \\"ModifiedSource\\": \\"2017-01-11T12:00:00Z\\",\\n \\"TemplateType\\": \\"Timeline\\",\\n \\"ProjectType\\": \\"EditingProject\\",\\n \\"BusinessConfig\\": \\"{ \\\\\\"OutputMediaConfig\\\\\\" : { \\\\\\"StorageLocation\\\\\\": \\\\\\"test-bucket.oss-cn-shanghai.aliyuncs.com\\\\\\", \\\\\\"Path\\\\\\": \\\\\\"test-path\\\\\\" }, \\\\\\"OutputMediaTarget\\\\\\": \\\\\\"oss-object\\\\\\", \\\\\\"ReservationTime\\\\\\": \\\\\\"2021-06-21T08:05:00Z\\\\\\" }\\",\\n \\"BusinessStatus\\": \\"Reserving\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 110,\\n \\"NextToken\\": \\"null\\"\\n}","errorExample":""},{"type":"xml","example":"<SearchEditingProjectResponse>\\n <RequestId>****9262E3DA-07FA-4862-FCBB6BC61D08*****</RequestId>\\n <ProjectList>\\n <ProjectId>****fddd7748b58bf1d47e95****</ProjectId>\\n <Title>title</Title>\\n <Timeline>{\\"VideoTracks\\":[{\\"VideoTrackClips\\":[{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"},{\\"MediaId\\":\\"****4d7cf14dc7b83b0e801c****\\"}]}]}</Timeline>\\n <Description>sample description</Description>\\n <CoverURL>http://example-bucket.oss-cn-shanghai.aliyuncs.com/example-cover.jpg</CoverURL>\\n <CreateTime>2017-01-11T12:00:00Z</CreateTime>\\n <ModifiedTime>2017-01-11T12:00:00Z</ModifiedTime>\\n <Status>PRODUCE_FAILED</Status>\\n <ErrorCode>InvalidParameter</ErrorCode>\\n <ErrorMessage>\\"EventTime\\":\\"2021-08-12T10:04:15Z\\",\\"ErrorCode\\":\\"InvalidParameter\\",\\"ErrorMessage\\":\\"The specified parameter \\\\\\"LiveStreamConfig\\\\\\" is not valid. specified parameter example is not valid.</ErrorMessage>\\n <CreateSource>OpenAPI</CreateSource>\\n <ModifiedSource>2017-01-11T12:00:00Z</ModifiedSource>\\n <TemplateType>Timeline</TemplateType>\\n <ProjectType>EditingProject</ProjectType>\\n </ProjectList>\\n <MaxResults>10</MaxResults>\\n <TotalCount>110</TotalCount>\\n <NextToken>null</NextToken>\\n</SearchEditingProjectResponse>","errorExample":""}]', + 'title' => '搜索云剪辑工程', + ], + 'SubmitDynamicChartJob' => [ + 'summary' => '根据Excel生成折线图、饼图、柱状图等视频，支持修改线条颜色、字体等信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ChartType', + 'in' => 'query', + 'schema' => [ + 'title' => '图表类型', + 'description' => '图表类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Line' => 'Line', + 'Histogram' => 'Histogram', + 'Pie' => 'Pie', + ], + 'example' => 'Line', + ], + ], + [ + 'name' => 'Input', + 'in' => 'query', + 'schema' => [ + 'title' => '图表输入数据', + 'description' => '图表输入数据', + 'type' => 'string', + 'required' => true, + 'example' => '{"XlsFile":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.xls"}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '输出设置', + 'description' => '输出设置', + 'type' => 'string', + 'required' => true, + 'example' => '{"MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.mp4","Bitrate":2000,"Width":800,"Height":680}', + ], + ], + [ + 'name' => 'ChartConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '图表配置', + 'description' => '图表配置', + 'type' => 'string', + 'required' => false, + 'example' => '{"Style":"Normal","TitleStartTime":"3000","ChartStartTime":"3000","VideoDuration":"15000"}', + ], + ], + [ + 'name' => 'ChartTitle', + 'in' => 'query', + 'schema' => [ + 'title' => '主标题', + 'description' => '主标题', + 'type' => 'string', + 'required' => false, + 'example' => '{"Text":"主标题","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', + ], + ], + [ + 'name' => 'Subtitle', + 'in' => 'query', + 'schema' => [ + 'title' => '副标题', + 'description' => '副标题', + 'type' => 'string', + 'required' => false, + 'example' => '{"Text":"副标题","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', + ], + ], + [ + 'name' => 'Unit', + 'in' => 'query', + 'schema' => [ + 'title' => '单位', + 'description' => '单位', + 'type' => 'string', + 'required' => false, + 'example' => '{"Text":"单位","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', + ], + ], + [ + 'name' => 'DataSource', + 'in' => 'query', + 'schema' => [ + 'title' => '数据来源', + 'description' => '数据来源', + 'type' => 'string', + 'required' => false, + 'example' => '{"Text":"数据来源","FontSize":"30","FontColor":"#000000","FontFile":"Microsoft YaHei"}', + ], + ], + [ + 'name' => 'Background', + 'in' => 'query', + 'schema' => [ + 'title' => '图表背景', + 'description' => '图表背景', + 'type' => 'string', + 'required' => false, + 'example' => '{"Color":"#000000","ImageUrl":"http://your-bucket.oss-cn-shanghai.aliyuncs.com/obj.jpg"}', + ], + ], + [ + 'name' => 'AxisParams', + 'in' => 'query', + 'schema' => [ + 'title' => '坐标样式。XAxisFontInterval不传或为0则算法自动计算间距', + 'description' => '坐标样式。XAxisFontInterval不传或为0则算法自动计算间距', + 'type' => 'string', + 'required' => false, + 'example' => '{"FontFile":"Microsoft YaHei","XAxisFontSize":"30","YAxisFontSize":"30","XAxisFontInterval":"30","AxisColor":"30"}', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'title' => '任务标题', + 'description' => '任务标题', + 'type' => 'string', + 'required' => false, + 'example' => '任务标题', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '任务描述', + 'description' => '任务描述', + 'type' => 'string', + 'required' => false, + 'example' => '任务描述', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义数据，JSON格式', + 'description' => '自定义数据，JSON格式', + 'type' => 'string', + 'required' => false, + 'example' => '{"user":"data"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'title' => '任务Id', + 'description' => '任务Id', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitDynamicChartJobResponse>\\n <RequestId>******11-DB8D-4A9A-875B-275798******</RequestId>\\n <JobId>****20b48fb04483915d4f2cd8ac****</JobId>\\n</SubmitDynamicChartJobResponse>","errorExample":""}]', + 'title' => '提交动态图表任务', + 'description' => '根据Excel数据生成图表视频，目前支持折线图、柱状图、饼图，目前仅在上海区域可用。'."\n" + .'- 支持设置图表标题、子标题、数据来源、单位等文案，支持设置文案字体、字号，目前支持字体：[字体列表](~~449567~~)。'."\n" + .'- 支持内置5种风格，风格枚举值：Normal / Mystery / Lively / Business / Green。'."\n" + .'- 支持设置背景颜色、背景图片。'."\n" + .'- 支持设置视频时长、尺寸、码率。'."\n" + ."\n" + .'参考示例：'."\n" + .'- 折线图：[Excel示例](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.xlsx)，[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/line.mp4)。'."\n" + .'- 柱状图：[Excel示例](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.xlsx)，[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/histgram.mp4)。'."\n" + .'- 饼图：[Excel示例](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.xlsx)，[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/pie.mp4)。'."\n" + .'- Normal风格：[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Normal.mp4)。'."\n" + .'- Mystery风格：[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Mystery.mp4)。'."\n" + .'- Lively风格：[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Lively.mp4)。'."\n" + .'- Business风格：[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Business.mp4)。'."\n" + .'- Green风格：[合成效果](https://ice-public-media.oss-cn-shanghai.aliyuncs.com/smart/dynamicChart/Green.mp4)。', + 'responseParamsDescription' => '动态图表任务执行结果可以用任务JobId通过[获取智能任务结果接口](~~441172~~)查询任务执行详细信息，任务执行成功时[获取智能任务结果接口](~~441172~~)返回结果示例如下。'."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "******2D-443C-5043-B0E4-867070******",'."\n" + .' "JobResult": {'."\n" + .' "MediaId": "******bf47c94e82b3b2014361******"'."\n" + .' },'."\n" + .' "State": "Finished",'."\n" + .' "JobId": "******042d5e4db6866f6289d1******",'."\n" + .' "SmartJobInfo": {'."\n" + .' "JobType": "DynamicChart",'."\n" + .' "ModifiedTime": "2022-01-21T07:02:02Z",'."\n" + .' "UserId": 1234562230123456,'."\n" + .' "CreateTime": "2022-01-21T07:02:02Z",'."\n" + .' "Title": "欧叔的动态图表用例1",'."\n" + .' "EditingConfig": "null"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'StopRtcRobotInstance' => [ + 'summary' => '停止一个RTC互动AI智能体实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228874', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '727dc0e296014bb58670940a3da95592', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'AC84E5DD-AB56-56C0-A992-07ECB82008CA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC84E5DD-AB56-56C0-A992-07ECB82008CA\\"\\n}","type":"json"}]', + 'title' => '停止RTC互动AI智能体实例', + ], + 'StartRtcRobotInstance' => [ + 'summary' => '启动一个RTC互动AI智能体实例，并加入RTC通话。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228630', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'RobotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI智能体ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ca28b08ad3464ebcb42e5c0f7c6d2e89', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'RTC的频道ID', + 'type' => 'string', + 'required' => true, + 'example' => 'testId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AI智能体在频道中的ID', + 'type' => 'string', + 'required' => true, + 'example' => 'my-robot', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '用户自定义信息', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'AuthToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'RTC的入会凭证，需要用户自己通过RTC的AppKey生成', + 'type' => 'string', + 'required' => true, + 'example' => '**********', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通话高级配置。如果填写，会覆盖AI智能体创建时的默认配置；否则使用创建时的默认配置。', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => [ + 'description' => '是否允许语音打断', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Greeting' => [ + 'description' => '欢迎语，即AI智能体在用户入会后主动说的一句话', + 'type' => 'string', + 'required' => false, + 'example' => '你好，有什么可以帮助的吗？', + ], + 'VoiceId' => [ + 'description' => '音色ID', + 'type' => 'string', + 'required' => false, + 'example' => 'zhixiaoxia', + ], + 'AsrMaxSilence' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + 'UserOnlineTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + 'UserOfflineTimeout' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + 'VoiceprintId' => [ + 'type' => 'string', + 'required' => false, + ], + 'UseVoiceprint' => [ + 'type' => 'boolean', + 'required' => false, + ], + 'Volume' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '该实例ID', + 'type' => 'string', + 'example' => '727dc0e296014bb58670940a3da95592', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '11DE0AB3-603B-5055-8A72-9C424854F983', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceId\\": \\"727dc0e296014bb58670940a3da95592\\",\\n \\"RequestId\\": \\"11DE0AB3-603B-5055-8A72-9C424854F983\\"\\n}","type":"json"}]', + 'title' => '启动RTC互动AI智能体实例', + ], + 'UpdateRtcRobotInstance' => [ + 'summary' => '修改一个RTC互动AI智能体实例配置，如音色、欢迎语等', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230669', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '727dc0e296014bb58670940a3da95592', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '配置', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => [ + 'description' => '是否允许语音打断，立即生效', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Greeting' => [ + 'description' => '欢迎语，若欢迎语已播报则修改无效', + 'type' => 'string', + 'required' => false, + 'example' => '你好', + ], + 'VoiceId' => [ + 'description' => '音色ID，修改后AI智能体下一句话生效', + 'type' => 'string', + 'required' => false, + 'example' => 'zhixiaoxia', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7707F0A2-C6FD-5959-87EB-7C4D02384FD4', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7707F0A2-C6FD-5959-87EB-7C4D02384FD4\\"\\n}","type":"json"}]', + 'title' => '更新RTC互动AI智能体实例', + ], + 'DescribeRtcRobotInstance' => [ + 'summary' => '查询一个RTC互动AI智能体实例的信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230670', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '727dc0e296014bb58670940a3da95592', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'AuthToken' => [ + 'description' => 'RTC的入会凭证', + 'type' => 'string', + 'example' => '**********', + ], + 'ChannelId' => [ + 'description' => '频道ID', + 'type' => 'string', + 'example' => 'testId', + ], + 'Config' => [ + 'description' => 'AI智能体高级配置', + 'type' => 'object', + 'properties' => [ + 'EnableVoiceInterrupt' => [ + 'description' => '是否允许语音打断', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Greeting' => [ + 'description' => '欢迎语', + 'type' => 'string', + 'example' => '你好', + ], + 'VoiceId' => [ + 'description' => '音色ID', + 'type' => 'string', + 'example' => 'zhixiaoxia', + ], + ], + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91', + ], + 'Status' => [ + 'description' => '实例状态：'."\n" + ."\n" + .'- Executing运行中'."\n" + ."\n" + .'- Finished结束', + 'type' => 'string', + 'example' => 'Executing', + ], + 'UserData' => [ + 'description' => '用户自定义信息', + 'type' => 'string', + 'example' => '{}', + ], + 'UserId' => [ + 'description' => 'AI智能体在频道中的ID', + 'type' => 'string', + 'example' => 'my-robot', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AuthToken\\": \\"**********\\",\\n \\"ChannelId\\": \\"testId\\",\\n \\"Config\\": {\\n \\"EnableVoiceInterrupt\\": true,\\n \\"Greeting\\": \\"你好\\",\\n \\"VoiceId\\": \\"zhixiaoxia\\"\\n },\\n \\"RequestId\\": \\"20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91\\",\\n \\"Status\\": \\"Executing\\",\\n \\"UserData\\": \\"{}\\",\\n \\"UserId\\": \\"my-robot\\"\\n}","type":"json"}]', + 'title' => '查询RTC互动AI智能体实例', + ], + 'SetNotifyConfig' => [ + 'summary' => '启用或禁用智能体事件通知，并配置回调URL与关注的事件类型。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236010', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体ID。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + [ + 'name' => 'EnableNotify', + 'in' => 'query', + 'schema' => [ + 'description' => '用于开启或关闭事件回调的开关。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'CallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户希望接收回调通知的URL。默认不填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://customer.com/callback', + ], + ], + [ + 'name' => 'EventTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '事件类型，不填写则全选。'."\n" + .'- agent_start'."\n" + .'- agent_stop'."\n" + .'- error', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'agent_start' => 'agent_start', + 'error' => 'error', + 'agent_stop' => 'agent_stop', + ], + 'example' => 'agent_start,agent_stop,error', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '回调的鉴权token。发送回调请求时携带在请求头的 Authorization 字段中。默认不填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + ], + [ + 'name' => 'AudioOssPath', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EnableAudioRecording', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => '771A1414-27BF-53E6-AB73-EFCB*****ACF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"771A1414-27BF-53E6-AB73-EFCB*****ACF\\"\\n}","type":"json"}]', + 'title' => '设置智能体事件回调通知配置', + 'description' => '## 请求说明'."\n" + ."\n" + .'该接口用于设置智能体实例的事件通知配置。用户可以通过此接口来控制是否开启事件通知功能（`EnableNotify`），设置接收通知的回调地址（`CallbackUrl`），以及指定希望接收哪些类型的事件通知（`EventTypes`）。此外，还可以传递一个校验Token（`Token`）以增强安全性。请求成功后，会返回一个唯一的请求ID（`RequestId`）供后续追踪使用。'."\n", + ], + 'DescribeNotifyConfig' => [ + 'summary' => '获取指定智能体的事件回调设置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236017', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'AIAgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能体ID。', + 'type' => 'string', + 'required' => true, + 'example' => '39f8e0bc005e4f309379701645f4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'CallbackUrl' => [ + 'description' => '用户希望接收回调通知的URL。', + 'type' => 'string', + 'example' => 'http://customer.com/callback', + ], + 'EnableNotify' => [ + 'description' => '用于开启或关闭通知的开关。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EventTypes' => [ + 'description' => '事件类型，不填写则全选。'."\n" + .'- agent_start 智能体就绪'."\n" + .'- agent_stop 智能体停止'."\n" + .'- error 任务错误', + 'type' => 'string', + 'enumValueTitles' => [ + 'agent_start' => 'agent_start', + 'error' => 'error', + 'agent_stop' => 'agent_stop', + ], + 'example' => 'agent_start,agent_stop,error', + ], + 'Token' => [ + 'description' => '回调的鉴权token。发送回调请求时携带在请求头的 Authorization 字段中。', + 'type' => 'string', + 'example' => 'eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx', + ], + 'AudioOssPath' => [ + 'type' => 'string', + ], + 'EnableAudioRecording' => [ + 'type' => 'boolean', + ], + 'RequestId' => [ + 'description' => '请求Id。', + 'type' => 'string', + 'example' => '7B117AF5-2A16-412C-B127-FA6175ED1AD0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CallbackUrl\\": \\"http://customer.com/callback\\",\\n \\"EnableNotify\\": true,\\n \\"EventTypes\\": \\"agent_start,agent_stop,error\\",\\n \\"Token\\": \\"eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx\\",\\n \\"AudioOssPath\\": \\"\\",\\n \\"EnableAudioRecording\\": true,\\n \\"RequestId\\": \\"7B117AF5-2A16-412C-B127-FA6175ED1AD0\\"\\n}","type":"json"}]', + 'title' => '查询智能体通知配置', + 'description' => '**功能描述**：此接口用于查询指定智能体（AIAgent）的事件回调配置详情。', + ], + 'CancelIProductionJob' => [ + 'summary' => '调用CancelIProductionJob取消智能生产任务。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREice405U0J', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能任务ID', + 'type' => 'string', + 'required' => true, + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '****12e8864746a0a398****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'Message' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => 'Success', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => [ + 'description' => '鉴权Action', + 'type' => 'string', + 'example' => 'ice:CancelIProductionJob', + ], + 'AuthPrincipalDisplayName' => [ + 'description' => '请求中用于鉴权的身份标识。具体取值为：'."\n" + .'- RAM 用户：RAM 用户 UID'."\n" + .'- RAM 角色：RoleName:RoleSessionName'."\n" + .'- Federated：ProviderType/ProviderName', + 'type' => 'string', + 'example' => '****4522705967****', + ], + 'AuthPrincipalOwnerId' => [ + 'description' => '身份验证主体所属账号', + 'type' => 'string', + 'example' => '****82303720****', + ], + 'AuthPrincipalType' => [ + 'description' => '请求中用于鉴权的身份类型。具体取值为：'."\n" + .'- RAM 用户：SubUser'."\n" + .'- RAM 角色：AssumedRoleUser'."\n" + .'- SSO 联合身份：Federated', + 'type' => 'string', + 'example' => 'SubUser', + ], + 'EncodedDiagnosticMessage' => [ + 'description' => '编码诊断信息', + 'type' => 'string', + 'example' => '******AAZ/h8jzNEODc5QUUyLUZCOTAtNUQyQy1BMEFBLUUzODQxODUx******==', + ], + 'NoPermissionType' => [ + 'description' => '权限策略拒绝的类型，取值如下：'."\n" + .'- **ImplicitDeny**：资源持有者未配置相关权限策略给当前用户，缺省拒绝未授权的操作。'."\n" + .'- **ExplicitDeny**：资源持有者配置的RAM策略明确拒绝了当前用户访问对应的资源。', + 'type' => 'string', + 'example' => 'ImplicitDeny', + ], + 'PolicyType' => [ + 'description' => '引起无权限的策略类型，取值如下：'."\n" + .'- **ControlPolicy** ：管控策略。'."\n" + .'- **SessionPolicy**：临时Token额外添加的一个权限策略。'."\n" + .'- **AssumeRolePolicy**：RAM角色的授信策略。'."\n" + .'- **AccountLevelIdentityBasedPolicy**：账号授权范围的主体策略，包含自定义策略和系统策略。'."\n" + .'- **ResourceGroupLevelIdentityBasedPolicy**：资源组授权范围的主体策略，包含自定义策略和系统策略。', + 'type' => 'string', + 'example' => 'AssumeRolePolicy', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"Message\\": \\"Success\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"ice:CancelIProductionJob\\",\\n \\"AuthPrincipalDisplayName\\": \\"****4522705967****\\",\\n \\"AuthPrincipalOwnerId\\": \\"****82303720****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"******AAZ/h8jzNEODc5QUUyLUZCOTAtNUQyQy1BMEFBLUUzODQxODUx******==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"AssumeRolePolicy\\"\\n }\\n}","type":"json"}]', + 'title' => '取消智能生产任务', + ], + 'SubmitSceneMediaSelectionJob' => [ + 'summary' => '根据传入的视频、图片、口播等素材，挑选合适的素材片段，并返回挑选结果。支持两种场景：智能匹配、高燃混剪。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输出配置', + 'description' => '输入配置，和一键成片图文匹配/高燃混剪能力的InputConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Media_Select 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Media_Select 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" + .' "MediaArray": ['."\n" + .' "https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .' ],'."\n" + .' "SpeechTextArray": ['."\n" + .' "附近的商场新开了一家盒马鲜生，今天是第一天开业",'."\n" + .' "商场里的人不少，零食、酒水都比较便宜大家也快来看看呀"'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '剪辑配置。和一键成片图文匹配/高燃混剪能力的EditingConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Media_Select 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Media_Select 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 0'."\n" + .' },'."\n" + .' "SpeechConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "BackgroundMusicConfig": {'."\n" + .' "Volume": 0.3'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务来源', + 'description' => '输出配置，和一键成片图文匹配/高燃混剪能力的OutputConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Media_Select 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Media_Select 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置说明](~~357745#section-urj-v3f-0s1~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + .'- Smart_Mix_Media_Select： 智能匹配素材挑选'."\n" + .'- Screen_Media_Highlights_Media_Select：高燃混剪素材挑选'."\n" + ."\n" + .'两种场景区别在于：'."\n" + .'- 智能匹配：传入口播文案以及视频、图片素材，根据口播文案内容挑选最匹配的视频、图片素材，并返回文案和素材的匹配结果。包含通用版和影视集锦版两种子场景，其中通用版适用于生活、旅游、营销等日常通用素材，影视集锦版则更适用于影视剧、电影等有剧情的素材。'."\n" + .'- 高燃混剪：传入视频素材（通常为多集短剧），自动根据高燃定义或按照故事线挑选合适的高燃片段，用于后续混剪成片。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Smart_Mix_Media_Select', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '*****ACB-44F2-5F2D-88D7-1283E70*****', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"*****ACB-44F2-5F2D-88D7-1283E70*****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交场景化素材挑选任务', + 'description' => '- 提交场景化素材挑选任务后，您可以调用[ListBatchMediaProducingJob](~~2803751~~)获取所有符合条件的任务列表。调用[GetBatchMediaProducingJob](~~2693269~~)获取任务详细信息，包括任务的状态、合成的媒资ID及URL等。'."\n" + .'- 公测中，暂不计费。', + ], + 'SubmitSceneBatchEditingJob' => [ + 'summary' => '输入多个剪辑工程ID，批量提交时间线合成，生成多个视频。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectIds', + 'in' => 'query', + 'schema' => [ + 'description' => '剪辑工程ID列表，用来获取时间线并合成成片。多值用英文逗号隔开。', + 'type' => 'string', + 'required' => true, + 'example' => '****ae91539d46bb9000f74b40b80dd2,****ae91539000f74b40b80dd9d46bb', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务输出配置', + 'description' => '输出配置。除不支持配置Count和GeneratePreviewOnly外，其他参数和一键成片[OutputConfig](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.3af86997GreVu9&scm=20140722.H_2863940._.OR_help-T_cn~zh-V_1#4111a373d0xbz)配置相同。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置说明](~~357745#section-urj-v3f-0s1~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '****C702-41BE-467E-AF2E-883D4517****', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"****C702-41BE-467E-AF2E-883D4517****\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交场景化批量合成任务', + 'description' => '- 提交场景化批量合成任务后，您可以调用ListBatchMediaProducingJob获取所有符合条件的任务列表。调用GetBatchMediaProducingJob获取任务详细信息，包括任务的状态、合成的媒资ID及URL等。', + ], + 'SubmitSceneTimelineOrganizationJob' => [ + 'summary' => '根据素材挑选结果，将视频、图片、背景音乐、口播等素材编排成完整时间线，并创建剪辑工程以便预览。支持两种场景：智能匹配、高燃混剪。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREiceANRKXC', + ], + ], + 'parameters' => [ + [ + 'name' => 'InputConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户合成输入配置', + 'description' => '输入配置，和一键成片图文匹配/高燃混剪能力的InputConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Timeline_Organize 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Timeline_Organize 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "BackgroundMusic": "****75c3936f3a8743850f2da942****",'."\n" + .' "MediaArray": ['."\n" + .' "https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4"'."\n" + .' ],'."\n" + .' "SpeechTextArray": ['."\n" + .' "附近的商场新开了一家盒马鲜生，今天是第一天开业"'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'EditingConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '剪辑配置。和一键成片图文匹配/高燃混剪能力的EditingConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Timeline_Organize 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Timeline_Organize 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "MediaConfig": {'."\n" + .' "Volume": 0'."\n" + .' },'."\n" + .' "SpeechConfig": {'."\n" + .' "Volume": 1'."\n" + .' },'."\n" + .' "BackgroundMusicConfig": {'."\n" + .' "Volume": 0.3'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'OutputConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '任务输出配置', + 'description' => '输出配置，和一键成片图文匹配/高燃混剪能力的OutputConfig参数一致。'."\n" + .'- JobType = Smart_Mix_Timeline_Organize 时，详见[图文匹配参数配置](https://help.aliyun.com/zh/ims/use-cases/intelligent-graphic-matching-into-a-piece/?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_1.7c3d6997qndkZj)'."\n" + .'- JobType = Screen_Media_Highlights_Timeline_Organize 时，详见[高燃混剪参数配置](https://help.aliyun.com/zh/ims/use-cases/create-highlight-videos?spm=a2c4g.11186623.help-menu-193643.d_3_2_0_3.84b5661bIcQULE)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "MediaURL": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4",'."\n" + .' "Count": 1,'."\n" + .' "Width": 1080,'."\n" + .' "Height": 1920'."\n" + .'}', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '用户配置UserData', + 'description' => '用户业务配置、回调配置。具体结构定义，请参见[UserData配置说明](~~357745#section-urj-v3f-0s1~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotifyAddress":"http://xx.xx.xxx"}或{"NotifyAddress":"https://xx.xx.xxx"}或{"NotifyAddress":"ice-callback-demo"}', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + .'- Smart_Mix_Timeline_Organize： 智能匹配时间线编排'."\n" + .'- Screen_Media_Highlights_Timeline_Organize：高燃混剪时间线编排'."\n" + ."\n" + .'两种场景区别在于：'."\n" + .'- 智能匹配：针对智能匹配场景的素材挑选结果（口播文案和素材的匹配结果），自动编排一个或多个成片的时间线，多适用于批量营销、通用混剪场景。'."\n" + .'- 高燃混剪：针对高燃混剪场景的素材挑选结果（高燃片段的挑选结果）自动编排一个或多个成片的时间线，多适用于短剧高燃混剪场景。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Smart_Mix_Timeline_Organize', + ], + ], + [ + 'name' => 'MediaSelectResult', + 'in' => 'query', + 'schema' => [ + 'description' => '素材挑选结果。可调用SubmitSceneMediaSelectionJob 提交素材挑选任务，并通过GetBatchMediaProducingJob 获取挑选结果。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "textMatchMediaOutputList": [{'."\n" + .' "textMatchMediaSentenceOutputList": [{'."\n" + .' "duration": 3.366667,'."\n" + .' "matchClipList": [{'."\n" + .' "endTime": 11.16,'."\n" + .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .' "startTime": 8.04'."\n" + .' }],'."\n" + .' "text": "附近的商场新开了一家盒马鲜生"'."\n" + .' },'."\n" + .' {'."\n" + .' "duration": 1.566667,'."\n" + .' "matchClipList": [{'."\n" + .' "endTime": 1.54,'."\n" + .' "mediaId": "****a0900f5071efbf1ce7e6c66a****",'."\n" + .' "startTime": 0'."\n" + .' }],'."\n" + .' "text": "今天是第一天开业"'."\n" + .' }'."\n" + .' ]'."\n" + .' }]'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '******11-DB8D-4A9A-875B-275798******', + ], + 'JobId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '****20b48fb04483915d4f2cd8ac****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"******11-DB8D-4A9A-875B-275798******\\",\\n \\"JobId\\": \\"****20b48fb04483915d4f2cd8ac****\\"\\n}","type":"json"}]', + 'title' => '提交场景化时间线编排任务', + 'description' => '- 提交场景化时间线编排任务后，您可以调用[ListBatchMediaProducingJob](~~2803751~~)获取所有符合条件的任务列表。调用[GetBatchMediaProducingJob](~~2693269~~)获取任务详细信息，包括任务的状态、合成的媒资ID及URL等。'."\n" + .'- 公测中，暂不收费。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ice.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ice.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ice.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ice.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ice.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ice.us-west-1.aliyuncs.com', + ], + ], +]; |