-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcme.d.ts
2422 lines (2213 loc) · 113 KB
/
cme.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 制作云用户账号信息。 */
declare interface AccountInfo {
/** 用户 Id。 */
UserId: string;
/** 用户手机号码。 */
Phone: string;
/** 用户昵称。 */
Nick: string;
/** 账号状态,取值:Normal:有效;Stopped:无效。 */
Status: string;
}
/** 添加的团队成员信息 */
declare interface AddMemberInfo {
/** 团队成员 ID。 */
MemberId: string;
/** 团队成员备注。 */
Remark?: string;
/** 团队成员角色,不填则默认添加普通成员。可选值:Admin:团队管理员;Member:普通成员。 */
Role?: string;
}
/** 音频素材信息 */
declare interface AudioMaterial {
/** 素材元信息。 */
MetaData: MediaMetaData;
/** 素材媒体文件的播放 URL 地址。 */
MaterialUrl: string;
/** 素材媒体文件的封面图片地址。 */
CoverUrl: string;
/** 素材状态。 */
MaterialStatus: MaterialStatus | null;
/** 素材媒体文件的原始 URL 地址。 */
OriginalUrl: string;
/** 云点播媒资 FileId。 */
VodFileId: string;
}
/** 音频流信息。 */
declare interface AudioStreamInfo {
/** 码率,单位:bps。 */
Bitrate: number;
/** 采样率,单位:hz。 */
SamplingRate: number;
/** 编码格式。 */
Codec: string;
}
/** 音频轨道上的音频片段信息。 */
declare interface AudioTrackItem {
/** 音频媒体来源类型,取值有:VOD :素材来源于云点播文件 ;CME :视频来源于制作云媒体文件 ;EXTERNAL :视频来源于媒资绑定,如果媒体不是存储在腾讯云点播中或者云创中,都需要使用媒资绑定。 */
SourceType: string;
/** 音频媒体,可取值为:当 SourceType 为 VOD 时,参数填云点播 FileId ;当 SourceType 为 CME 时,参数填多媒体创作引擎媒体 Id;当 SourceType 为 EXTERNAL 时,目前仅支持外部媒体 URL(如`https://www.example.com/a.mp3`),参数填写规则请参见注意事项。注意:当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 `https` 时(如:`https://www.example.com/a.mp3`),参数为:`1000000:www.example.com/a.mp3`。当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 `http` 时(如:`http://www.example.com/b.mp3`),参数为:`1000001:www.example.com/b.mp3`。 */
SourceMedia: string;
/** 音频片段取自媒体文件的起始时间,单位为秒。0 表示从媒体开始位置截取。默认为0。 */
SourceMediaStartTime?: number;
/** 音频片段的时长,单位为秒。默认和媒体本身长度一致,表示截取全部媒体。 */
Duration?: number;
}
/** 资源权限信息 */
declare interface AuthorizationInfo {
/** 被授权者实体。 */
Authorizee?: Entity;
/** 详细授权值。 取值有:R:可读,可以浏览素材,但不能使用该素材(将其添加到 Project),或复制到自己的媒资库中。X:可用,可以使用该素材(将其添加到 Project),但不能将其复制到自己的媒资库中,意味着被授权者无法将该资源进一步扩散给其他个人或团队。C:可复制,既可以使用该素材(将其添加到 Project),也可以将其复制到自己的媒资库中。W:可修改、删除媒资。 */
PermissionSet?: string[];
}
/** 授权者 */
declare interface Authorizer {
/** 授权者类型,取值有:PERSON:个人。TEAM:团队。 */
Type: string;
/** Id,当 Type=PERSON,取值为用户 Id。当Type=TEAM,取值为团队 ID。 */
Id: string;
}
/** 多媒体创作引擎导出信息。 */
declare interface CMEExportInfo {
/** 导出媒体归属,个人或团队。 */
Owner: Entity;
/** 导出的媒体名称,不得超过30个字符。 */
Name?: string;
/** 导出的媒体信息,不得超过50个字符。 */
Description?: string;
/** 导出的媒体分类路径,长度不能超过15字符。不存在默认创建。 */
ClassPath?: string;
/** 导出的媒体标签,单个标签不得超过10个字符。 */
TagSet?: string[];
/** 第三方平台发布信息列表。暂未正式对外,请勿使用。 */
ThirdPartyPublishInfos?: ThirdPartyPublishInfo[];
}
/** 分类创建事件。 */
declare interface ClassCreatedEvent {
/** 分类归属。 */
Owner: Entity;
/** 分类路径。 */
ClassPath: string;
}
/** 分类删除事件。 */
declare interface ClassDeletedEvent {
/** 删除的分类归属。 */
Owner: Entity;
/** 删除的分类路径列表。 */
ClassPathSet: string[];
}
/** 分类信息 */
declare interface ClassInfo {
/** 归属者。 */
Owner: Entity;
/** 分类路径。 */
ClassPath: string;
}
/** 分类移动事件。 */
declare interface ClassMovedEvent {
/** 源分类归属。 */
SourceOwner: Entity;
/** 源分类路径列表。 */
SourceClassPathSet: string[];
/** 目标分类归属。 */
DestinationOwner: Entity;
/** 目标分类归属。 */
DestinationClassPath: string;
}
/** COS 发布信息。 */
declare interface CosPublishInputInfo {
/** 发布生成的对象存储文件所在的 COS Bucket 名,如 TopRankVideo-125xxx88。 */
Bucket: string;
/** 发布生成的对象存储文件所在的 COS Bucket 所属园区,如 ap-chongqing。 */
Region: string;
/** 发布生成的视频在 COS 存储的对象键。对象键(ObjectKey)是对象(Object)在存储桶(Bucket)中的唯一标识。 */
VideoKey: string;
/** 发布生成的封面在 COS 存储的对象键。 */
CoverKey: string;
}
/** 空的轨道片段,用来进行时间轴的占位。如需要两个音频片段之间有一段时间的静音,可以用 EmptyTrackItem 来进行占位。 */
declare interface EmptyTrackItem {
/** 持续时间,单位为秒。 */
Duration: number;
}
/** 用于描述资源的归属,归属者为个人或者团队。 */
declare interface Entity {
/** 类型,取值有:PERSON:个人。TEAM:团队。 */
Type: string;
/** Id,当 Type=PERSON,取值为用户 Id,当 Type=TEAM,取值为团队 Id。 */
Id: string;
}
/** 回调事件内容。 */
declare interface EventContent {
/** 事件类型,可取值有:Storage.NewFileCreated:新文件产生事件;Project.StreamConnect.StatusChanged:云转推项目状态变更事件;Project.Switcher.StatusChanged:导播台项目状态变更事件;Material.Imported:媒体导入事件;Material.Added:媒体添加事件;Material.Moved:媒体移动事件;Material.Modified:媒体变更事件;Material.Deleted:媒体删除事件;Class.Created:分类新增事件;Class.Moved:分类移动事件;Class.Deleted:分类删除事件;Task.VideoExportCompleted:视频导出完成事件; Project.MediaCast.StatusChanged:点播转直播项目状态变更事件。 */
EventType: string;
/** 操作者,表示触发事件的操作者。如果是 `cmeid_system` 表示平台管理员操作。 */
Operator: string;
/** 新文件产生事件。仅当 EventType 为 Storage.NewFileCreated 时有效。 */
StorageNewFileCreatedEvent: StorageNewFileCreatedEvent;
/** 云转推项目状态变更事件。仅当 EventType 为 Project.StreamConnect.StatusChanged 时有效。 */
ProjectStreamConnectStatusChangedEvent: ProjectStreamConnectStatusChangedEvent;
/** 导播台项目状态变更事件。仅当 EventType 为 Project.Switcher.StatusChanged 时有效。 */
ProjectSwitcherStatusChangedEvent: ProjectSwitcherStatusChangedEvent | null;
/** 媒体导入事件。仅当 EventType 为 Material.Imported 时有效。 */
MaterialImportedEvent: MaterialImportedEvent | null;
/** 媒体添加事件。仅当 EventType 为 Material.Added 时有效。 */
MaterialAddedEvent: MaterialAddedEvent | null;
/** 媒体移动事件。仅当 EventType 为 Material.Moved 时有效。 */
MaterialMovedEvent: MaterialMovedEvent | null;
/** 媒体更新事件。仅当 EventType 为 Material.Modified 时有效。 */
MaterialModifiedEvent: MaterialModifiedEvent | null;
/** 媒体删除事件。仅当 EventType 为 Material.Deleted 时有效。 */
MaterialDeletedEvent: MaterialDeletedEvent | null;
/** 分类创建事件。仅当 EventType 为 Class.Created 时有效。 */
ClassCreatedEvent: ClassCreatedEvent | null;
/** 分类移动事件。仅当 EventType 为 Class.Moved 时有效。 */
ClassMovedEvent: ClassMovedEvent | null;
/** 分类删除事件。仅当 EventType 为 Class.Deleted 时有效。 */
ClassDeletedEvent: ClassDeletedEvent | null;
/** 视频导出完成事件。仅当 EventType 为 Task.VideoExportCompleted 时有效。 */
VideoExportCompletedEvent: VideoExportCompletedEvent | null;
/** 点播转直播项目状态变更事件。仅当 EventType 为 Project.MediaCast.StatusChanged 时有效。 */
ProjectMediaCastStatusChangedEvent: ProjectMediaCastStatusChangedEvent | null;
}
/** 媒资绑定资源信息,包含媒资绑定模板 ID 和文件信息。 */
declare interface ExternalMediaInfo {
/** 目前仅支持绑定 COS 桶的媒体,请填写存储对象 Key 值,例如:`example-folder/example.mp4`。 */
MediaKey: string;
/** 该字段废弃,请勿使用。 */
Definition?: number;
/** 媒资挂载的存储 Id。 */
StorageId?: string;
}
/** 图片素材信息 */
declare interface ImageMaterial {
/** 图片高度,单位:px。 */
Height: number;
/** 图片宽度,单位:px。 */
Width: number;
/** 素材媒体文件的展示 URL 地址。 */
MaterialUrl: string;
/** 图片大小,单位:字节。 */
Size: number;
/** 素材媒体文件的原始 URL 地址。 */
OriginalUrl: string;
/** 云点播媒资 FileId。 */
VodFileId: string;
}
/** 导入媒资信息 */
declare interface ImportMediaInfo {
/** 云点播文件 FileId。 */
FileId: string;
/** 媒体 Id。 */
MaterialId: string;
}
/** 整型范围 */
declare interface IntegerRange {
/** 按整形代表值的下限检索。 */
LowerBound: number;
/** 按整形代表值的上限检索。 */
UpperBound: number;
}
/** 加入的团队信息 */
declare interface JoinTeamInfo {
/** 团队 ID。 */
TeamId: string;
/** 团队名称。 */
Name: string;
/** 团队成员个数。 */
MemberCount: number;
/** 成员在团队中的角色,取值有:Owner:团队所有者,添加团队成员及修改团队成员解决时不能填此角色;Admin:团队管理员;Member:普通成员。 */
Role: string;
}
/** 快手视频发布信息。 */
declare interface KuaishouPublishInfo {
/** 视频发布标题,限30个字符。 */
Title?: string;
}
/** 链接类型的素材信息 */
declare interface LinkMaterial {
/** 链接类型取值:CLASS: 分类链接; MATERIAL:素材链接。 */
LinkType: string;
/** 链接状态取值: Normal:正常 ;NotFound:链接目标不存在; Forbidden:无权限。 */
LinkStatus: string;
/** 素材链接详细信息,当LinkType="MATERIAL"时有值。 */
LinkMaterialInfo: LinkMaterialInfo | null;
/** 分类链接目标信息,当LinkType=“CLASS”时有值。 */
LinkClassInfo: ClassInfo | null;
}
/** 链接素材信息 */
declare interface LinkMaterialInfo {
/** 素材基本信息。 */
BasicInfo: MaterialBasicInfo;
/** 视频素材信息。 */
VideoMaterial: VideoMaterial | null;
/** 音频素材信息。 */
AudioMaterial: AudioMaterial | null;
/** 图片素材信息。 */
ImageMaterial: ImageMaterial | null;
}
/** 直播拉流信息 */
declare interface LivePullInputInfo {
/** 直播拉流地址。 */
InputUrl: string;
}
/** 直播剪辑项目输入参数。 */
declare interface LiveStreamClipProjectInput {
/** 直播流播放地址,目前仅支持 HLS 和 FLV 格式。 */
Url: string;
/** 直播流录制时长,单位为秒,最大值为 7200。 */
StreamRecordDuration: number;
}
/** 登录态信息 */
declare interface LoginStatusInfo {
/** 用户 Id。 */
UserId: string;
/** 用户登录状态。Online:在线;Offline:离线。 */
Status: string;
}
/** 媒体添加事件。 */
declare interface MaterialAddedEvent {
/** 添加的媒体 Id 列表。 */
MaterialIdSet: string[];
/** 添加的媒体归属。 */
Owner: Entity;
/** 添加的媒体分类路径。 */
ClassPath: string;
}
/** 媒体基本信息。 */
declare interface MaterialBasicInfo {
/** 媒体 Id。 */
MaterialId: string;
/** 媒体类型,取值为: AUDIO :音频; VIDEO :视频; IMAGE :图片; LINK :链接. OTHER : 其他. */
MaterialType: string;
/** 媒体归属实体。 */
Owner: Entity;
/** 媒体名称。 */
Name: string;
/** 媒体文件的创建时间,使用 ISO 日期格式。 */
CreateTime: string;
/** 媒体文件的最近更新时间(如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作),使用 ISO 日期格式。 */
UpdateTime: string;
/** 媒体的分类路径。 */
ClassPath: string;
/** 预置标签列表。 */
PresetTagSet: PresetTagInfo[];
/** 人工标签列表。 */
TagSet: string[];
/** 媒体文件的预览图。 */
PreviewUrl: string;
/** 媒体绑定的标签信息列表 。该字段已废弃。 */
TagInfoSet: MaterialTagInfo[] | null;
}
/** 媒体删除事件。 */
declare interface MaterialDeletedEvent {
/** 删除的媒体 Id 列表。 */
MaterialIdSet: string[];
}
/** 媒体导入事件 */
declare interface MaterialImportedEvent {
/** 导入的媒体信息列表。 */
MediaInfoSet: ImportMediaInfo[];
/** 媒体归属。 */
Owner: Entity;
/** 媒体分类路径。 */
ClassPath: string;
}
/** 媒体详情信息 */
declare interface MaterialInfo {
/** 媒体基本信息。 */
BasicInfo?: MaterialBasicInfo;
/** 视频媒体信息。 */
VideoMaterial?: VideoMaterial | null;
/** 音频媒体信息。 */
AudioMaterial?: AudioMaterial | null;
/** 图片媒体信息。 */
ImageMaterial?: ImageMaterial | null;
/** 链接媒体信息。 */
LinkMaterial?: LinkMaterial | null;
/** 模板媒体信息。 */
VideoEditTemplateMaterial?: VideoEditTemplateMaterial | null;
/** 其他类型媒体信息。 */
OtherMaterial?: OtherMaterial | null;
}
/** 媒体更新事件。 */
declare interface MaterialModifiedEvent {
/** 媒体 Id。 */
MaterialId: string;
/** 更新后的媒体名称。如未更新则为空。 */
Name: string;
/** 更新后的媒体预置标签列表。如未更新媒体预置标签,则该字段为空数组。 */
PresetTagIdSet: string[];
/** 更新后的媒体自定义标签列表。如未更新媒体自定义标签,则该字段为空数组。 */
TagSet: string[];
}
/** 媒体移动事件 */
declare interface MaterialMovedEvent {
/** 要移动的媒体 Id 列表。 */
MaterialIdSet: string[];
/** 源媒体归属。 */
SourceOwner: Entity;
/** 源媒体分类路径。 */
SourceClassPath: string;
/** 目标媒体分类归属。 */
DestinationOwner: Entity;
/** 目标媒体分类路径。 */
DestinationClassPath: string;
}
/** 素材的状态,目前仅包含素材编辑可用状态。 */
declare interface MaterialStatus {
/** 素材编辑可用状态,取值有:NORMAL:正常,可直接用于编辑;ABNORMAL : 异常,不可用于编辑;PROCESSING:处理中,暂不可用于编辑。 */
EditorUsableStatus: string;
}
/** 素材标签信息 */
declare interface MaterialTagInfo {
/** 标签类型,取值为:PRESET:预置标签; */
Type: string;
/** 标签 Id 。当标签类型为 PRESET 时,标签 Id 为预置标签 Id 。 */
Id: string;
/** 标签名称。 */
Name: string;
}
/** 点播转直播输出信息。 */
declare interface MediaCastDestinationInfo {
/** 输出源 Id。由系统进行分配。 */
Id?: string;
/** 输出直播流地址。支持的直播流类型为 RTMP 和 SRT。 */
PushUrl?: string;
/** 输出源的名称。 */
Name?: string;
}
/** 点播转直播输出断流信息。 */
declare interface MediaCastDestinationInterruptInfo {
/** 发生断流的输出源信息。 */
DestinationInfo: MediaCastDestinationInfo;
/** 输出源断流原因,取值有:SystemError:系统错误;Unknown:未知错误。 */
Reason: string;
}
/** 点播转直播输出源状态信息。 */
declare interface MediaCastDestinationStatus {
/** 输出源 Id,由系统分配。 */
Id?: string;
/** 输出源直播地址。 */
PushUrl: string;
/** 输出源的状态。取值有: Working :运行中; Stopped:停止输出; Failed:输出失败。 */
Status: string;
}
/** 点播转直播输出媒体配置。 */
declare interface MediaCastOutputMediaSetting {
/** 视频配置。 */
VideoSetting: MediaCastVideoSetting;
/** 视频配置是否和第一个输入源的视频配置相同,默认值:false。如果 FollowSourceInfo 的值为 true,忽略 VideoSetting 参数。 */
FollowSourceInfo?: boolean;
}
/** 点播转直播播放信息。 */
declare interface MediaCastPlayInfo {
/** 点播转直播项目运行状态,取值有: Working : 运行中; Idle: 空闲状态。 */
Status: string;
/** 当前播放的输入源 Id。 */
CurrentSourceId?: string;
/** 当前播放的输入源的播放位置,单位:秒。 */
CurrentSourcePosition: number;
/** 当前播放的输入源时长,单位:秒。 */
CurrentSourceDuration: number;
/** 输出源状态信息。 */
DestinationStatusSet: MediaCastDestinationStatus[];
/** 已经循环播放的次数。 */
LoopCount: number;
}
/** 播放控制参数。 */
declare interface MediaCastPlaySetting {
/** 循环播放次数。LoopCount 和 EndTime 同时只能有一个生效。默认循环播放次数为一次。如果同时设置了 LoopCount 和 EndTime 参数,优先使用 LoopCount 参数。 */
LoopCount?: number;
/** 结束时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。 */
EndTime?: string;
/** 自动启动时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。 */
AutoStartTime?: string;
}
/** 点播转直播项目信息。 */
declare interface MediaCastProjectInfo {
/** 点播转直播项目状态,取值有:Working :运行中;Idle :空闲。 */
Status?: string;
/** 输入源列表。 */
SourceInfos?: MediaCastSourceInfo[];
/** 输出源列表。 */
DestinationInfos?: MediaCastDestinationInfo[];
/** 输出媒体配置。 */
OutputMediaSetting?: MediaCastOutputMediaSetting;
/** 播放参数。 */
PlaySetting?: MediaCastPlaySetting;
/** 项目启动时间。采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。 */
StartTime?: string;
/** 项目结束时间。采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。如果项目还在运行中,该字段为空。 */
StopTime?: string;
/** 推流时长,单位:秒。项目结束后,返回上次项目运行时的推流时长。如果项目是 Working 状态,返回的时长是0。 */
Duration?: number;
}
/** 点播转直播项目输入信息。 */
declare interface MediaCastProjectInput {
/** 输入源列表。输入源列表最大个数为100. */
SourceInfos?: MediaCastSourceInfo[];
/** 输出源列表。输出源列表最大个数为10. */
DestinationInfos?: MediaCastDestinationInfo[];
/** 输出媒体配置。 */
OutputMediaSetting?: MediaCastOutputMediaSetting;
/** 播放控制参数。 */
PlaySetting?: MediaCastPlaySetting;
}
/** 点播转直播输入源信息。 */
declare interface MediaCastSourceInfo {
/** 输入源 Id,由系统分配。 */
Id?: string | null;
/** 输入源的媒体类型,取值有:CME:多媒体创作引擎的媒体文件;VOD:云点播的媒资文件。EXTERNAL:非多媒体创建引擎或者云点播的媒资文件。 */
Type?: string;
/** 云点播媒体文件 ID。当 Type = VOD 时必填。 */
FileId?: string;
/** 多媒体创作引擎的媒体 ID。当 Type = CME 时必填。 */
MaterialId?: string;
/** 文件播放的起始位置,单位:秒。默认为0,从文件头开始播放。当 Type = CME 或者 VOD 时有效。 */
Offset?: number;
/** 播放时长,单位:秒。默认播放整个文件。当 Type = CME 或者 VOD 时有效。 */
Duration?: number;
/** 外部文件的 Url, Type=EXTERNAL 时必填,可以是点播文件或者直播文件,支持的 Scheme 包括HTTP、HTTPS、RTMP。 */
Url?: string;
}
/** 点播转直播输入断流信息。 */
declare interface MediaCastSourceInterruptInfo {
/** 发生断流的输入源信息。 */
SourceInfo: MediaCastSourceInfo;
/** 输入源断开原因。取值有:SystemError:系统错误;Unknown:未知错误。 */
Reason: string;
}
/** 点播转直播视频配置 */
declare interface MediaCastVideoSetting {
/** 视频宽度,单位:px,默认值为1280。 */
Width: number;
/** 视频高度,单位:px,默认值为720。支持的视频分辨率最大为1920*1080。 */
Height: number;
/** 视频码率,单位:kbps,默认值为2500。最大值为10000 kbps。 */
Bitrate?: number;
/** 视频帧率,单位:Hz,默认值为25。最大值为60。 */
FrameRate?: number;
}
/** 雪碧图 */
declare interface MediaImageSpriteInfo {
/** 雪碧图小图的高度。 */
Height: number;
/** 雪碧图小图的宽度。 */
Width: number;
/** 雪碧图小图的总数量。 */
TotalCount: number;
/** 截取雪碧图输出的地址。 */
ImageUrlSet: string[];
/** 雪碧图子图位置与时间关系的 WebVtt 文件地址。WebVtt 文件表明了各个雪碧图小图对应的时间点,以及在雪碧大图里的坐标位置,一般被播放器用于实现预览。 */
WebVttUrl: string;
}
/** 文件元信息。 */
declare interface MediaMetaData {
/** 大小。 */
Size: number;
/** 容器类型。 */
Container: string;
/** 视频流码率平均值与音频流码率平均值之和,单位:bps。 */
Bitrate: number;
/** 视频流高度的最大值,单位:px。 */
Height: number;
/** 视频流宽度的最大值,单位:px。 */
Width: number;
/** 时长,单位:秒。 */
Duration: number;
/** 视频拍摄时的选择角度,单位:度 */
Rotate: number;
/** 视频流信息。 */
VideoStreamInfoSet: VideoStreamInfo[];
/** 音频流信息。 */
AudioStreamInfoSet: AudioStreamInfo[];
}
/** 媒体处理视频合成任务的预处理操作。 */
declare interface MediaPreprocessOperation {
/** 预处理操作的类型,取值范围:ImageTextMask:图片文字遮罩。 */
Type: string;
/** 预处理操作参数。当 Type 取值 ImageTextMask 时,参数为要保留的文字。 */
Args?: string[];
}
/** 媒体替换信息。 */
declare interface MediaReplacementInfo {
/** 替换的媒体类型,取值有:CMEMaterialId:替换的媒体类型为媒体 ID;ImageUrl:替换的媒体类型为图片 URL;注:默认为 CMEMaterialId 。 */
MediaType?: string;
/** 媒体 ID。当媒体类型取值为 CMEMaterialId 时有效。 */
MaterialId?: string;
/** 媒体 URL。当媒体类型取值为 ImageUrl 时有效,图片仅支持 jpg、png 格式,且大小不超过 2M 。 */
MediaUrl?: string;
/** 替换媒体选取的开始时间,单位为秒,默认为 0。 */
StartTimeOffset?: number;
/** 预处理操作。注:目前该功能暂不支持,请勿使用。 */
PreprocessOperation?: MediaPreprocessOperation;
}
/** 轨道信息 */
declare interface MediaTrack {
/** 轨道类型,取值有:Video :视频轨道。视频轨道由以下 Item 组成:VideoTrackItemEmptyTrackItemMediaTransitionItem Audio :音频轨道。音频轨道由以下 Item 组成:AudioTrackItemEmptyTrackItem */
Type: string;
/** 轨道上的媒体片段列表。 */
TrackItems: MediaTrackItem[];
}
/** 媒体轨道的片段信息 */
declare interface MediaTrackItem {
/** 片段类型。取值有:Video:视频片段;Audio:音频片段;Empty:空白片段;Transition:转场。 */
Type: string;
/** 视频片段,当 Type = Video 时有效。 */
VideoItem?: VideoTrackItem;
/** 音频片段,当 Type = Audio 时有效。 */
AudioItem?: AudioTrackItem;
/** 空白片段,当 Type = Empty 时有效。空片段用于时间轴的占位。如需要两个音频片段之间有一段时间的静音,可以用 EmptyTrackItem 来进行占位。使用 EmptyTrackItem 进行占位,来定位某个Item。 */
EmptyItem?: EmptyTrackItem;
/** 转场,当 Type = Transition 时有效。 */
TransitionItem?: MediaTransitionItem;
}
/** 转场信息 */
declare interface MediaTransitionItem {
/** 转场 Id 。暂只支持一个转场。 */
TransitionId: string;
/** 转场持续时间,单位为秒,默认为2秒。进行转场处理的两个媒体片段,第二个片段在轨道上的起始时间会自动进行调整,设置为前面一个片段的结束时间减去转场的持续时间。 */
Duration?: number;
}
/** 其他类型素材 */
declare interface OtherMaterial {
/** 素材媒体文件的播放 URL 地址。 */
MaterialUrl: string;
/** 云点播媒资 FileId。 */
VodFileId: string;
}
/** 企鹅号发布信息。 */
declare interface PenguinMediaPlatformPublishInfo {
/** 视频发布标题。 */
Title?: string;
/** 视频发布描述信息。 */
Description?: string;
/** 视频标签。 */
Tags?: string[];
/** 视频分类,详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。 */
Category?: number;
}
/** 平台信息。 */
declare interface PlatformInfo {
/** 平台标识。 */
Platform: string;
/** 平台描述。 */
Description: string;
/** 云点播子应用 Id。 */
VodSubAppId: number;
/** 平台绑定的 license Id。 */
LicenseId: string;
/** 平台状态,可取值为:Normal:正常,可使用。;Stopped:已停用,暂无法使用;Expired:已过期,需要重新购买会员包。 */
Status: string;
/** 创建时间,格式按照 ISO 8601 标准表示。 */
CreateTime: string;
/** 更新时间,格式按照 ISO 8601 标准表示。 */
UpdateTime: string;
}
/** 预置标签信息 */
declare interface PresetTagInfo {
/** 标签 Id 。 */
Id: string;
/** 标签名称。 */
Name: string;
/** 父级预设 Id。 */
ParentTagId?: string;
}
/** 项目信息。 */
declare interface ProjectInfo {
/** 项目 Id。 */
ProjectId: string;
/** 项目名称。 */
Name: string;
/** 画布宽高比。 */
AspectRatio: string;
/** 项目类别,取值有:VIDEO_EDIT:视频编辑。SWITCHER:导播台。VIDEO_SEGMENTATION:视频拆条。STREAM_CONNECT:云转推。RECORD_REPLAY:录制回放。 */
Category: string;
/** 归属者。 */
Owner: Entity;
/** 项目封面图片地址。 */
CoverUrl: string;
/** 云转推项目信息,仅当项目类别取值 STREAM_CONNECT 时有效。 */
StreamConnectProjectInfo: StreamConnectProjectInfo | null;
/** 点播转直播项目信息,仅当项目类别取值为 MEDIA_CAST 时有效。 */
MediaCastProjectInfo: MediaCastProjectInfo | null;
/** 项目更新时间,格式按照 ISO 8601 标准表示。 */
UpdateTime: string;
/** 项目创建时间,格式按照 ISO 8601 标准表示。 */
CreateTime: string;
}
/** 点播转直播项目状态变更事件。 */
declare interface ProjectMediaCastStatusChangedEvent {
/** 项目 Id。 */
ProjectId: string;
/** 项目状态,取值有:Started:点播转直播开始;Stopped:点播转直播结束;SourceInterrupted:点播转直播输入断流;DestinationInterrupted:点播转直播输出断流。 */
Status: string;
/** 点播转直播输入断流信息,仅当 Status 取值 SourceInterrupted 时有效。 */
SourceInterruptInfo: MediaCastSourceInterruptInfo;
/** 点播转直播输出断流信息,仅当 Status 取值 DestinationInterrupted 时有效。 */
DestinationInterruptInfo: MediaCastDestinationInterruptInfo;
}
/** 云转推项目状态变更事件。 */
declare interface ProjectStreamConnectStatusChangedEvent {
/** 项目 Id。 */
ProjectId: string;
/** 项目状态,取值有:Working:云转推推流开始;Stopped:云转推推流结束;InputInterrupted:云转推输入断流;OutputInterrupted:云转推输出断流。 */
Status: string;
/** 云转推输入断流信息,仅当 Status 取值 InputInterrupted 时有效。 */
InputInterruptInfo: StreamConnectInputInterruptInfo | null;
/** 云转推输出断流信息,仅当 Status 取值 OutputInterrupted 时有效。 */
OutputInterruptInfo: StreamConnectOutputInterruptInfo | null;
}
/** 导播台项目状态变更事件 */
declare interface ProjectSwitcherStatusChangedEvent {
/** 导播台项目 Id。 */
ProjectId: string;
/** 导播台项目状态,可取值有:Started:导播台启动;Stopped:导播台停止;PvwStarted:导播台 PVW 开启;PgmStarted:导播台 PGM 开启,输出推流开始;PvwStopped:导播台 PVW 停止;PgmStopped:导播台 PGM 停止,输出推流结束。 */
Status: string;
}
/** 录制回放项目输入信息。 */
declare interface RecordReplayProjectInput {
/** 录制拉流地址。 */
PullStreamUrl: string;
/** 录制文件归属者。 */
MaterialOwner: Entity;
/** 录制文件存储分类路径。 */
MaterialClassPath: string;
/** 回放推流地址。 */
PushStreamUrl: string;
}
/** 用于描述资源 */
declare interface Resource {
/** 类型,取值有:MATERIAL:素材。CLASS:分类。 */
Type: string;
/** 资源 Id,当 Type 为 MATERIAL 时,取值为素材 Id;当 Type 为 CLASS 时,取值为分类路径 ClassPath。 */
Id: string;
}
/** 资源信息,包含资源以及归属信息 */
declare interface ResourceInfo {
/** 媒资和分类资源。 */
Resource: Resource | null;
/** 资源归属,个人或团队。 */
Owner: Entity;
}
/** 直播推流信息,包括推流地址有效时长,多媒体创作引擎后端生成直播推流地址。 */
declare interface RtmpPushInputInfo {
/** 直播推流地址有效期,单位:秒 。 */
ExpiredSecond: number;
/** 直播推流地址,入参不填默认由多媒体创作引擎生成。 */
PushUrl?: string;
}
/** 搜索空间 */
declare interface SearchScope {
/** 分类路径归属。 */
Owner: Entity;
/** 按分类路径检索。 不填则默认按根分类路径检索。 */
ClassPath?: string;
}
/** 卡槽信息。 */
declare interface SlotInfo {
/** 卡槽 Id。 */
Id?: number;
/** 卡槽类型,可取值有: AUDIO:音频卡槽,可替换素材类型为 AUDIO 的音频素材; VIDEO:视频卡槽,可替换素材类型为 VIDEO 的视频素材; IMAGE:图片卡槽,可替换素材类型为 IMAGE 的图片素材; TEXT:文本卡槽,可替换文本内容。 */
Type?: string;
/** 默认素材ID。当卡槽类型为 AUDIO,VIDEO,或 IMAGE 中的一种时有效。 */
DefaultMaterialId?: string;
/** 默认文本卡槽信息。当卡槽类型为 TEXT 时有效。 */
DefaultTextSlotInfo?: TextSlotInfo | null;
/** 素材时长,单位秒。 */
Duration?: number;
/** 卡槽起始时间,单位秒。 */
StartTime?: number;
}
/** 卡槽替换信息。 */
declare interface SlotReplacementInfo {
/** 卡槽 Id。 */
Id: number;
/** 替换类型,可取值有: AUDIO :音频; VIDEO :视频; IMAGE :图片; TEXT :文本。注意:这里必须保证替换的素材类型与模板轨道数据的素材类型一致。如果替换的类型为Text,,则必须保证模板轨道数据中相应卡槽的位置标记的是文本。 */
ReplacementType: string;
/** 媒体替换信息,仅当要替换的媒体类型为音频、视频、图片时有效。 */
MediaReplacementInfo?: MediaReplacementInfo;
/** 文本替换信息,仅当要替换的卡槽类型为文本时有效。 */
TextReplacementInfo?: TextReplacementInfo;
}
/** 排序 */
declare interface SortBy {
/** 排序字段。 */
Field: string;
/** 排序方式,可选值:Asc(升序)、Desc(降序),默认降序。 */
Order?: string;
}
/** 新文件生成事件 */
declare interface StorageNewFileCreatedEvent {
/** 云点播文件 Id。 */
FileId: string;
/** 媒体 Id。 */
MaterialId: string;
/** 操作者 Id。(废弃,请勿使用) */
Operator: string;
/** 操作类型,可取值有:Upload:本地上传;PullUpload:拉取上传;VideoEdit:视频剪辑;LiveStreamClip:直播流剪辑;LiveStreamRecord:直播流录制。 */
OperationType: string;
/** 媒体归属。 */
Owner: Entity;
/** 媒体分类路径。 */
ClassPath: string;
/** 生成文件的任务 Id。当生成新文件是拉取上传、视频剪辑、直播流剪辑时为任务 Id。 */
TaskId: string;
/** 来源上下文信息。视频剪辑生成新文件时此字段为项目 Id;直播流剪辑或者直播流录制生成新文件则为原始流地址。 */
SourceContext: string;
}
/** 云转推输入断流信息。 */
declare interface StreamConnectInputInterruptInfo {
/** 云转推输入源标识,取值有:Main:主源;Backup:备源。 */
EndPoint: string;
}
/** 云转推输出源。 */
declare interface StreamConnectOutput {
/** 云转推输出源标识,转推项目级别唯一。若不填则由后端生成。 */
Id?: string;
/** 云转推输出源名称。 */
Name?: string;
/** 云转推输出源类型,取值:URL :URL类型不填默认为URL类型。 */
Type?: string;
/** 云转推推流地址。 */
PushUrl?: string;
}
/** 云转推输出源信息,包含输出源和输出源转推状态。 */
declare interface StreamConnectOutputInfo {
/** 输出源。 */
StreamConnectOutput: StreamConnectOutput | null;
/** 输出流状态:On :开;Off :关 。 */
PushSwitch: string;
}
/** 云转推输出断流信息 */
declare interface StreamConnectOutputInterruptInfo {
/** 云转推输出标识。 */
Id: string;
/** 云转推输出名称。 */
Name: string;
/** 云转推输出地址。 */
Url: string;
}
/** 云转推项目信息,包含输入源、输出源、当前转推开始时间等信息。 */
declare interface StreamConnectProjectInfo {
/** 转推项目状态,取值有:Working :转推中;Idle :空闲中。 */
Status: string;
/** 当前转推输入源,取值有:Main :主输入源;Backup :备输入源。 */
CurrentInputEndpoint: string;
/** 当前转推开始时间, 采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。仅 Status 取值 Working 时有效。 */
CurrentStartTime: string;
/** 当前转推计划结束时间, 采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。仅 Status 取值 Working 时有效。 */
CurrentStopTime: string;
/** 上一次转推结束时间, 采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732)。仅 Status 取值 Idle 时有效。 */
LastStopTime: string;
/** 云转推主输入源。 */
MainInput: StreamInputInfo | null;
/** 云转推备输入源。 */
BackupInput: StreamInputInfo | null;
/** 云转推输出源。 */
OutputSet: StreamConnectOutputInfo[];
}
/** 云转推项目输入信息。 */
declare interface StreamConnectProjectInput {
/** 云转推主输入源信息。 */
MainInput?: StreamInputInfo;
/** 云转推备输入源信息。 */
BackupInput?: StreamInputInfo;
/** 云转推输出源信息。 */
Outputs?: StreamConnectOutput[];
}
/** 输入流信息。 */
declare interface StreamInputInfo {
/** 流输入类型,取值:VodPull : 点播拉流;LivePull :直播拉流;RtmpPush : 直播推流。 */
InputType: string;
/** 点播拉流信息,当 InputType = VodPull 时必填。 */
VodPullInputInfo?: VodPullInputInfo | null;
/** 直播拉流信息,当 InputType = LivePull 时必填。 */
LivePullInputInfo?: LivePullInputInfo | null;
/** 直播推流信息,当 InputType = RtmpPush 时必填。 */
RtmpPushInputInfo?: RtmpPushInputInfo | null;
}
/** 导播台主监输出配置信息 */
declare interface SwitcherPgmOutputConfig {
/** 导播台输出模板 ID,可取值:10001:分辨率为1080 P;10002:分辨率为720 P;10003:分辨率为480 P。 */
TemplateId?: number;
/** 导播台输出宽,单位:像素。 */
Width?: number;
/** 导播台输出高,单位:像素。 */
Height?: number;
/** 导播台输出帧率,单位:帧/秒 */
Fps?: number;
/** 导播台输出码率, 单位:bit/s。 */
BitRate?: number;
}
/** 导播台项目输入信息 */
declare interface SwitcherProjectInput {
/** 导播台停止时间,格式按照 ISO 8601 标准表示。若不填,该值默认为当前时间加七天。 */
StopTime?: string;
/** 导播台主监输出配置信息。若不填,默认输出 720P。 */
PgmOutputConfig?: SwitcherPgmOutputConfig;
}
/** 任务基础信息。 */
declare interface TaskBaseInfo {
/** 任务 Id。 */
TaskId: string;
/** 任务类型,取值有:VIDEO_EDIT_PROJECT_EXPORT:项目导出。 */
TaskType: string;
/** 任务状态,取值有:PROCESSING:处理中:SUCCESS:成功;FAIL:失败。 */
Status: string;
/** 任务进度,取值为:0~100。 */
Progress: number;
/** 错误码。0:成功;其他值:失败。 */
ErrCode: number;
/** 错误信息。 */
ErrMsg: string;
/** 创建时间,格式按照 ISO 8601 标准表示。 */
CreateTime: string;
}
/** 团队信息 */
declare interface TeamInfo {
/** 团队 ID。 */
TeamId: string;
/** 团队名称。 */
Name: string;
/** 团队成员个数 */
MemberCount?: number;
/** 团队创建时间,格式按照 ISO 8601 标准表示。 */
CreateTime?: string;
/** 团队最后更新时间,格式按照 ISO 8601 标准表示。 */
UpdateTime: string;
}
/** 团队成员信息 */
declare interface TeamMemberInfo {
/** 团队成员 ID。 */
MemberId: string;
/** 团队成员备注。 */
Remark?: string;
/** 团队成员角色,取值:Owner:团队所有者,添加团队成员及修改团队成员解决时不能填此角色;Admin:团队管理员;Member:普通成员。 */
Role?: string;
}
/** 模板插槽文本替换信息。 */
declare interface TextReplacementInfo {
/** 替换的文本信息。 */
Text: string;
}
/** 文本类型卡槽信息。 */
declare interface TextSlotInfo {
/** 文本内容。 */
Text?: string;
}
/** 第三方平台视频发布信息。 */
declare interface ThirdPartyPublishInfo {
/** 发布通道 ID。 */
ChannelMaterialId: string;
/** 企鹅号发布信息,如果使用的发布通道为企鹅号时必填。 */
PenguinMediaPlatformPublishInfo?: PenguinMediaPlatformPublishInfo;
/** 新浪微博发布信息,如果使用的发布通道为新浪微博时必填。 */
WeiboPublishInfo?: WeiboPublishInfo;
/** 快手发布信息,如果使用的发布通道为快手时必填。 */
KuaishouPublishInfo?: KuaishouPublishInfo;
/** 腾讯云对象存储发布信息, 如果使用的发布通道为腾讯云对象存储时必填。 */
CosPublishInfo?: CosPublishInputInfo;