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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="transcoder_v1beta1.html">Transcoder API</a> . <a href="transcoder_v1beta1.projects.html">projects</a> . <a href="transcoder_v1beta1.projects.locations.html">locations</a> . <a href="transcoder_v1beta1.projects.locations.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a job in the specified region.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a job.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the job data.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists jobs in the specified region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a job in the specified region.
Args:
parent: string, Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Transcoding job resource.
"config": { # Job configuration # The configuration for this job.
"adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
{ # Ad break.
"startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
},
],
"editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
{ # Edit atom.
"endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
"inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
"A String",
],
"key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
"startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
},
],
"elementaryStreams": [ # List of elementary streams.
{ # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
"audioStream": { # Audio stream resource. # Encoding of an audio stream.
"bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
"channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - 'fl' - Front left channel - 'fr' - Front right channel - 'sl' - Side left channel - 'sr' - Side right channel - 'fc' - Front center channel - 'lfe' - Low frequency
"A String",
],
"codec": "A String", # The codec for this audio stream. The default is `"aac"`. Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3'
"mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
"channels": [ # List of `Channel`s for this audio stream. for in-depth explanation.
{ # The audio channel.
"inputs": [ # List of `Job.inputs` for this audio channel.
{ # Identifies which input file, track, and channel should be used.
"channel": 42, # Required. The zero-based index of the channel in the input file.
"gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
},
],
"key": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
},
],
"sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
},
"key": "A String", # A unique key for this elementary stream.
"textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
"codec": "A String", # The codec for this text stream. The default is `"webvtt"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'
"languageCode": "A String", # Required. The BCP-47 language code, such as `"en-US"` or `"sr-Latn"`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
"inputs": [ # List of `Job.inputs` that should be embedded in this atom. Only one input is supported.
{ # Identifies which input file and track should be used.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
"key": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
},
],
},
"videoStream": { # Video stream resource. # Encoding of a video stream.
"allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
"aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
"bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
"bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
"bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value for H264/H265 is 800,000,000. The maximum value for VP9 is 480,000,000.
"codec": "A String", # Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`
"crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
"enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `"vbr"`. The default is `false`.
"entropyCoder": "A String", # The entropy coder to use. The default is `"cabac"`. Supported entropy coders: - 'cavlc' - 'cabac'
"frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
"gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `"3s"`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
"gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
"heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
"pixelFormat": "A String", # Pixel format to use. The default is `"yuv420p"`. Supported pixel formats: - 'yuv420p' pixel format. - 'yuv422p' pixel format. - 'yuv444p' pixel format. - 'yuv420p10' 10-bit HDR pixel format. - 'yuv422p10' 10-bit HDR pixel format. - 'yuv444p10' 10-bit HDR pixel format. - 'yuv420p12' 12-bit HDR pixel format. - 'yuv422p12' 12-bit HDR pixel format. - 'yuv444p12' 12-bit HDR pixel format.
"preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `"vbr"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor
"tune": "A String", # Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
"vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
"widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
},
},
],
"inputs": [ # List of input assets stored in Cloud Storage.
{ # Input asset.
"key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
"preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
"audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
"highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
"lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
"lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
},
"color": { # Color preprocessing configuration. # Color preprocessing configuration.
"brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
"contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
"saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
},
"crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
"bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
"rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
"topPixels": 42, # The number of pixels to crop from the top. The default is 0.
},
"deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
"enabled": True or False, # Enable deblocker. The default is `false`.
"strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
},
"denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
"strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
"tune": "A String", # Set the denoiser mode. The default is `"standard"`. Supported denoiser modes: - 'standard' - 'grain'
},
"pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
"bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to add to the left. The default is 0.
"rightPixels": 42, # The number of pixels to add to the right. The default is 0.
"topPixels": 42, # The number of pixels to add to the top. The default is 0.
},
},
"uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
},
],
"manifests": [ # List of output manifests.
{ # Manifest configuration.
"fileName": "A String", # The name of the generated file. The default is `"manifest"` with the extension suffix corresponding to the `Manifest.type`.
"muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
"A String",
],
"type": "A String", # Required. Type of the manifest, can be "HLS" or "DASH".
},
],
"muxStreams": [ # List of multiplexing settings for output streams.
{ # Multiplexing settings for output stream.
"container": "A String", # The container format. The default is `"mp4"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `".m4s"` - 'mp4' - 'vtt'
"elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
"A String",
],
"encryption": { # Encryption settings. # Encryption settings.
"aes128": { # Configuration for AES-128 encryption. # Configuration for AES-128 encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
"iv": "A String", # Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits.
"key": "A String", # Required. 128 bit encryption key represented as lowercase hexadecimal digits.
"mpegCenc": { # Configuration for MPEG Common Encryption (MPEG-CENC). # Configuration for MPEG Common Encryption (MPEG-CENC).
"keyId": "A String", # Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption.
"scheme": "A String", # Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'
},
"sampleAes": { # Configuration for SAMPLE-AES encryption. # Configuration for SAMPLE-AES encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
},
"fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"mux_stream0000000123.ts"`.
"key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `".m3u8"` extension suffix.
"segmentSettings": { # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`. # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`.
"individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
"segmentDuration": "A String", # Duration of the segments in seconds. The default is `"6.0s"`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
},
},
],
"output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
"uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
},
"overlays": [ # List of overlays on the output video, in descending Z-order.
{ # Overlay configuration.
"animations": [ # List of Animations. The list should be chronological, without any time overlap.
{ # Animation types.
"animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
"startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
},
"animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
"endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
"fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
"startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
"animationStatic": { # Display static overlay object. # Display static overlay object.
"startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
},
],
"image": { # Overlaid jpeg image. # Image overlay.
"alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
"resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
"uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
},
},
],
"pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
"topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
},
"spriteSheets": [ # List of output sprite sheets.
{ # Sprite sheet configuration.
"columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
"endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
"filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"sprite_sheet0000000123.jpeg"`.
"format": "A String", # Format type. The default is `"jpeg"`. Supported formats: - 'jpeg'
"interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
"quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
"rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
"spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
"spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
"startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
"totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
},
],
},
"createTime": "A String", # Output only. The time the job was created.
"endTime": "A String", # Output only. The time the transcoding finished.
"failureDetails": [ # Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.
{ # Additional information about the reasons for the failure.
"description": "A String", # A description of the failure.
},
],
"failureReason": "A String", # Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.
"inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
"name": "A String", # The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`
"originUri": { # The origin URI. # Output only. The origin URI. *Note*: This feature is not yet available.
"dash": "A String", # Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.
"hls": "A String", # HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.
},
"outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
"priority": 42, # Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
"progress": { # Estimated fractional progress for each step, from `0` to `1`. # Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.
"analyzed": 3.14, # Estimated fractional progress for `analyzing` step.
"encoded": 3.14, # Estimated fractional progress for `encoding` step.
"notified": 3.14, # Estimated fractional progress for `notifying` step.
"uploaded": 3.14, # Estimated fractional progress for `uploading` step.
},
"startTime": "A String", # Output only. The time the transcoding started.
"state": "A String", # Output only. The current state of the job.
"templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
"ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Transcoding job resource.
"config": { # Job configuration # The configuration for this job.
"adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
{ # Ad break.
"startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
},
],
"editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
{ # Edit atom.
"endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
"inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
"A String",
],
"key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
"startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
},
],
"elementaryStreams": [ # List of elementary streams.
{ # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
"audioStream": { # Audio stream resource. # Encoding of an audio stream.
"bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
"channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - 'fl' - Front left channel - 'fr' - Front right channel - 'sl' - Side left channel - 'sr' - Side right channel - 'fc' - Front center channel - 'lfe' - Low frequency
"A String",
],
"codec": "A String", # The codec for this audio stream. The default is `"aac"`. Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3'
"mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
"channels": [ # List of `Channel`s for this audio stream. for in-depth explanation.
{ # The audio channel.
"inputs": [ # List of `Job.inputs` for this audio channel.
{ # Identifies which input file, track, and channel should be used.
"channel": 42, # Required. The zero-based index of the channel in the input file.
"gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
},
],
"key": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
},
],
"sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
},
"key": "A String", # A unique key for this elementary stream.
"textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
"codec": "A String", # The codec for this text stream. The default is `"webvtt"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'
"languageCode": "A String", # Required. The BCP-47 language code, such as `"en-US"` or `"sr-Latn"`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
"inputs": [ # List of `Job.inputs` that should be embedded in this atom. Only one input is supported.
{ # Identifies which input file and track should be used.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
"key": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
},
],
},
"videoStream": { # Video stream resource. # Encoding of a video stream.
"allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
"aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
"bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
"bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
"bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value for H264/H265 is 800,000,000. The maximum value for VP9 is 480,000,000.
"codec": "A String", # Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`
"crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
"enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `"vbr"`. The default is `false`.
"entropyCoder": "A String", # The entropy coder to use. The default is `"cabac"`. Supported entropy coders: - 'cavlc' - 'cabac'
"frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
"gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `"3s"`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
"gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
"heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
"pixelFormat": "A String", # Pixel format to use. The default is `"yuv420p"`. Supported pixel formats: - 'yuv420p' pixel format. - 'yuv422p' pixel format. - 'yuv444p' pixel format. - 'yuv420p10' 10-bit HDR pixel format. - 'yuv422p10' 10-bit HDR pixel format. - 'yuv444p10' 10-bit HDR pixel format. - 'yuv420p12' 12-bit HDR pixel format. - 'yuv422p12' 12-bit HDR pixel format. - 'yuv444p12' 12-bit HDR pixel format.
"preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `"vbr"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor
"tune": "A String", # Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
"vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
"widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
},
},
],
"inputs": [ # List of input assets stored in Cloud Storage.
{ # Input asset.
"key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
"preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
"audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
"highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
"lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
"lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
},
"color": { # Color preprocessing configuration. # Color preprocessing configuration.
"brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
"contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
"saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
},
"crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
"bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
"rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
"topPixels": 42, # The number of pixels to crop from the top. The default is 0.
},
"deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
"enabled": True or False, # Enable deblocker. The default is `false`.
"strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
},
"denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
"strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
"tune": "A String", # Set the denoiser mode. The default is `"standard"`. Supported denoiser modes: - 'standard' - 'grain'
},
"pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
"bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to add to the left. The default is 0.
"rightPixels": 42, # The number of pixels to add to the right. The default is 0.
"topPixels": 42, # The number of pixels to add to the top. The default is 0.
},
},
"uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
},
],
"manifests": [ # List of output manifests.
{ # Manifest configuration.
"fileName": "A String", # The name of the generated file. The default is `"manifest"` with the extension suffix corresponding to the `Manifest.type`.
"muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
"A String",
],
"type": "A String", # Required. Type of the manifest, can be "HLS" or "DASH".
},
],
"muxStreams": [ # List of multiplexing settings for output streams.
{ # Multiplexing settings for output stream.
"container": "A String", # The container format. The default is `"mp4"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `".m4s"` - 'mp4' - 'vtt'
"elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
"A String",
],
"encryption": { # Encryption settings. # Encryption settings.
"aes128": { # Configuration for AES-128 encryption. # Configuration for AES-128 encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
"iv": "A String", # Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits.
"key": "A String", # Required. 128 bit encryption key represented as lowercase hexadecimal digits.
"mpegCenc": { # Configuration for MPEG Common Encryption (MPEG-CENC). # Configuration for MPEG Common Encryption (MPEG-CENC).
"keyId": "A String", # Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption.
"scheme": "A String", # Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'
},
"sampleAes": { # Configuration for SAMPLE-AES encryption. # Configuration for SAMPLE-AES encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
},
"fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"mux_stream0000000123.ts"`.
"key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `".m3u8"` extension suffix.
"segmentSettings": { # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`. # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`.
"individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
"segmentDuration": "A String", # Duration of the segments in seconds. The default is `"6.0s"`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
},
},
],
"output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
"uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
},
"overlays": [ # List of overlays on the output video, in descending Z-order.
{ # Overlay configuration.
"animations": [ # List of Animations. The list should be chronological, without any time overlap.
{ # Animation types.
"animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
"startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
},
"animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
"endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
"fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
"startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
"animationStatic": { # Display static overlay object. # Display static overlay object.
"startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
},
],
"image": { # Overlaid jpeg image. # Image overlay.
"alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
"resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
"uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
},
},
],
"pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
"topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
},
"spriteSheets": [ # List of output sprite sheets.
{ # Sprite sheet configuration.
"columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
"endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
"filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"sprite_sheet0000000123.jpeg"`.
"format": "A String", # Format type. The default is `"jpeg"`. Supported formats: - 'jpeg'
"interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
"quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
"rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
"spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
"spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
"startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
"totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
},
],
},
"createTime": "A String", # Output only. The time the job was created.
"endTime": "A String", # Output only. The time the transcoding finished.
"failureDetails": [ # Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.
{ # Additional information about the reasons for the failure.
"description": "A String", # A description of the failure.
},
],
"failureReason": "A String", # Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.
"inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
"name": "A String", # The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`
"originUri": { # The origin URI. # Output only. The origin URI. *Note*: This feature is not yet available.
"dash": "A String", # Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.
"hls": "A String", # HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.
},
"outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
"priority": 42, # Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
"progress": { # Estimated fractional progress for each step, from `0` to `1`. # Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.
"analyzed": 3.14, # Estimated fractional progress for `analyzing` step.
"encoded": 3.14, # Estimated fractional progress for `encoding` step.
"notified": 3.14, # Estimated fractional progress for `notifying` step.
"uploaded": 3.14, # Estimated fractional progress for `uploading` step.
},
"startTime": "A String", # Output only. The time the transcoding started.
"state": "A String", # Output only. The current state of the job.
"templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
"ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a job.
Args:
name: string, Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns the job data.
Args:
name: string, Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Transcoding job resource.
"config": { # Job configuration # The configuration for this job.
"adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
{ # Ad break.
"startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
},
],
"editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
{ # Edit atom.
"endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
"inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
"A String",
],
"key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
"startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
},
],
"elementaryStreams": [ # List of elementary streams.
{ # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
"audioStream": { # Audio stream resource. # Encoding of an audio stream.
"bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
"channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - 'fl' - Front left channel - 'fr' - Front right channel - 'sl' - Side left channel - 'sr' - Side right channel - 'fc' - Front center channel - 'lfe' - Low frequency
"A String",
],
"codec": "A String", # The codec for this audio stream. The default is `"aac"`. Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3'
"mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
"channels": [ # List of `Channel`s for this audio stream. for in-depth explanation.
{ # The audio channel.
"inputs": [ # List of `Job.inputs` for this audio channel.
{ # Identifies which input file, track, and channel should be used.
"channel": 42, # Required. The zero-based index of the channel in the input file.
"gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
},
],
"key": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
},
],
"sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
},
"key": "A String", # A unique key for this elementary stream.
"textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
"codec": "A String", # The codec for this text stream. The default is `"webvtt"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'
"languageCode": "A String", # Required. The BCP-47 language code, such as `"en-US"` or `"sr-Latn"`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
"inputs": [ # List of `Job.inputs` that should be embedded in this atom. Only one input is supported.
{ # Identifies which input file and track should be used.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
"key": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
},
],
},
"videoStream": { # Video stream resource. # Encoding of a video stream.
"allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
"aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
"bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
"bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
"bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value for H264/H265 is 800,000,000. The maximum value for VP9 is 480,000,000.
"codec": "A String", # Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`
"crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
"enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `"vbr"`. The default is `false`.
"entropyCoder": "A String", # The entropy coder to use. The default is `"cabac"`. Supported entropy coders: - 'cavlc' - 'cabac'
"frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
"gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `"3s"`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
"gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
"heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
"pixelFormat": "A String", # Pixel format to use. The default is `"yuv420p"`. Supported pixel formats: - 'yuv420p' pixel format. - 'yuv422p' pixel format. - 'yuv444p' pixel format. - 'yuv420p10' 10-bit HDR pixel format. - 'yuv422p10' 10-bit HDR pixel format. - 'yuv444p10' 10-bit HDR pixel format. - 'yuv420p12' 12-bit HDR pixel format. - 'yuv422p12' 12-bit HDR pixel format. - 'yuv444p12' 12-bit HDR pixel format.
"preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `"vbr"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor
"tune": "A String", # Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
"vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
"widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
},
},
],
"inputs": [ # List of input assets stored in Cloud Storage.
{ # Input asset.
"key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
"preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
"audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
"highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
"lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
"lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
},
"color": { # Color preprocessing configuration. # Color preprocessing configuration.
"brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
"contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
"saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
},
"crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
"bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
"rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
"topPixels": 42, # The number of pixels to crop from the top. The default is 0.
},
"deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
"enabled": True or False, # Enable deblocker. The default is `false`.
"strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
},
"denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
"strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
"tune": "A String", # Set the denoiser mode. The default is `"standard"`. Supported denoiser modes: - 'standard' - 'grain'
},
"pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
"bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to add to the left. The default is 0.
"rightPixels": 42, # The number of pixels to add to the right. The default is 0.
"topPixels": 42, # The number of pixels to add to the top. The default is 0.
},
},
"uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
},
],
"manifests": [ # List of output manifests.
{ # Manifest configuration.
"fileName": "A String", # The name of the generated file. The default is `"manifest"` with the extension suffix corresponding to the `Manifest.type`.
"muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
"A String",
],
"type": "A String", # Required. Type of the manifest, can be "HLS" or "DASH".
},
],
"muxStreams": [ # List of multiplexing settings for output streams.
{ # Multiplexing settings for output stream.
"container": "A String", # The container format. The default is `"mp4"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `".m4s"` - 'mp4' - 'vtt'
"elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
"A String",
],
"encryption": { # Encryption settings. # Encryption settings.
"aes128": { # Configuration for AES-128 encryption. # Configuration for AES-128 encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
"iv": "A String", # Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits.
"key": "A String", # Required. 128 bit encryption key represented as lowercase hexadecimal digits.
"mpegCenc": { # Configuration for MPEG Common Encryption (MPEG-CENC). # Configuration for MPEG Common Encryption (MPEG-CENC).
"keyId": "A String", # Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption.
"scheme": "A String", # Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'
},
"sampleAes": { # Configuration for SAMPLE-AES encryption. # Configuration for SAMPLE-AES encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
},
"fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"mux_stream0000000123.ts"`.
"key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `".m3u8"` extension suffix.
"segmentSettings": { # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`. # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`.
"individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
"segmentDuration": "A String", # Duration of the segments in seconds. The default is `"6.0s"`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
},
},
],
"output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
"uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
},
"overlays": [ # List of overlays on the output video, in descending Z-order.
{ # Overlay configuration.
"animations": [ # List of Animations. The list should be chronological, without any time overlap.
{ # Animation types.
"animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
"startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
},
"animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
"endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
"fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
"startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
"animationStatic": { # Display static overlay object. # Display static overlay object.
"startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
},
],
"image": { # Overlaid jpeg image. # Image overlay.
"alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
"resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
"uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
},
},
],
"pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
"topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
},
"spriteSheets": [ # List of output sprite sheets.
{ # Sprite sheet configuration.
"columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
"endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
"filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"sprite_sheet0000000123.jpeg"`.
"format": "A String", # Format type. The default is `"jpeg"`. Supported formats: - 'jpeg'
"interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
"quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
"rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
"spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
"spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
"startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
"totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
},
],
},
"createTime": "A String", # Output only. The time the job was created.
"endTime": "A String", # Output only. The time the transcoding finished.
"failureDetails": [ # Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.
{ # Additional information about the reasons for the failure.
"description": "A String", # A description of the failure.
},
],
"failureReason": "A String", # Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.
"inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
"name": "A String", # The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`
"originUri": { # The origin URI. # Output only. The origin URI. *Note*: This feature is not yet available.
"dash": "A String", # Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.
"hls": "A String", # HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.
},
"outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
"priority": 42, # Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
"progress": { # Estimated fractional progress for each step, from `0` to `1`. # Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.
"analyzed": 3.14, # Estimated fractional progress for `analyzing` step.
"encoded": 3.14, # Estimated fractional progress for `encoding` step.
"notified": 3.14, # Estimated fractional progress for `notifying` step.
"uploaded": 3.14, # Estimated fractional progress for `uploading` step.
},
"startTime": "A String", # Output only. The time the transcoding started.
"state": "A String", # Output only. The current state of the job.
"templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
"ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists jobs in the specified region.
Args:
parent: string, Required. Format: `projects/{project}/locations/{location}` (required)
pageSize: integer, The maximum number of items to return.
pageToken: string, The `next_page_token` value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TranscoderService.ListJobs`.
"jobs": [ # List of jobs in the specified region.
{ # Transcoding job resource.
"config": { # Job configuration # The configuration for this job.
"adBreaks": [ # List of ad breaks. Specifies where to insert ad break tags in the output manifests.
{ # Ad break.
"startTimeOffset": "A String", # Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.
},
],
"editList": [ # List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
{ # Edit atom.
"endTimeOffset": "A String", # End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
"inputs": [ # List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
"A String",
],
"key": "A String", # A unique key for this atom. Must be specified when using advanced mapping.
"startTimeOffset": "A String", # Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.
},
],
"elementaryStreams": [ # List of elementary streams.
{ # Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
"audioStream": { # Audio stream resource. # Encoding of an audio stream.
"bitrateBps": 42, # Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
"channelCount": 42, # Number of audio channels. Must be between 1 and 6. The default is 2.
"channelLayout": [ # A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - 'fl' - Front left channel - 'fr' - Front right channel - 'sl' - Side left channel - 'sr' - Side right channel - 'fc' - Front center channel - 'lfe' - Low frequency
"A String",
],
"codec": "A String", # The codec for this audio stream. The default is `"aac"`. Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3'
"mapping": [ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
"channels": [ # List of `Channel`s for this audio stream. for in-depth explanation.
{ # The audio channel.
"inputs": [ # List of `Job.inputs` for this audio channel.
{ # Identifies which input file, track, and channel should be used.
"channel": 42, # Required. The zero-based index of the channel in the input file.
"gainDb": 3.14, # Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
},
],
"key": "A String", # Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
},
],
"sampleRateHertz": 42, # The audio sample rate in Hertz. The default is 48000 Hertz.
},
"key": "A String", # A unique key for this elementary stream.
"textStream": { # Encoding of a text stream. For example, closed captions or subtitles. # Encoding of a text stream. For example, closed captions or subtitles.
"codec": "A String", # The codec for this text stream. The default is `"webvtt"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'
"languageCode": "A String", # Required. The BCP-47 language code, such as `"en-US"` or `"sr-Latn"`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
"mapping": [ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
{ # The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.
"inputs": [ # List of `Job.inputs` that should be embedded in this atom. Only one input is supported.
{ # Identifies which input file and track should be used.
"key": "A String", # Required. The `Input.key` that identifies the input file.
"track": 42, # Required. The zero-based index of the track in the input file.
},
],
"key": "A String", # Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
},
],
},
"videoStream": { # Video stream resource. # Encoding of a video stream.
"allowOpenGop": True or False, # Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
"aqStrength": 3.14, # Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
"bFrameCount": 42, # The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
"bPyramid": True or False, # Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
"bitrateBps": 42, # Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value for H264/H265 is 800,000,000. The maximum value for VP9 is 480,000,000.
"codec": "A String", # Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`
"crfLevel": 42, # Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
"enableTwoPass": True or False, # Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `"vbr"`. The default is `false`.
"entropyCoder": "A String", # The entropy coder to use. The default is `"cabac"`. Supported entropy coders: - 'cavlc' - 'cabac'
"frameRate": 3.14, # Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for more information.
"gopDuration": "A String", # Select the GOP size based on the specified duration. The default is `"3s"`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.
"gopFrameCount": 42, # Select the GOP size based on the specified frame count. Must be greater than zero.
"heightPixels": 42, # The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.
"pixelFormat": "A String", # Pixel format to use. The default is `"yuv420p"`. Supported pixel formats: - 'yuv420p' pixel format. - 'yuv422p' pixel format. - 'yuv444p' pixel format. - 'yuv420p10' 10-bit HDR pixel format. - 'yuv422p10' 10-bit HDR pixel format. - 'yuv444p10' 10-bit HDR pixel format. - 'yuv420p12' 12-bit HDR pixel format. - 'yuv422p12' 12-bit HDR pixel format. - 'yuv444p12' 12-bit HDR pixel format.
"preset": "A String", # Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"profile": "A String", # Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"rateControlMode": "A String", # Specify the `rate_control_mode`. The default is `"vbr"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor
"tune": "A String", # Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.
"vbvFullnessBits": 42, # Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
"vbvSizeBits": 42, # Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
"widthPixels": 42, # The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.
},
},
],
"inputs": [ # List of input assets stored in Cloud Storage.
{ # Input asset.
"key": "A String", # A unique key for this input. Must be specified when using advanced mapping and edit lists.
"preprocessingConfig": { # Preprocessing configurations. # Preprocessing configurations.
"audio": { # Audio preprocessing configuration. # Audio preprocessing configuration.
"highBoost": True or False, # Enable boosting high frequency components. The default is `false`.
"lowBoost": True or False, # Enable boosting low frequency components. The default is `false`.
"lufs": 3.14, # Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization
},
"color": { # Color preprocessing configuration. # Color preprocessing configuration.
"brightness": 3.14, # Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
"contrast": 3.14, # Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
"saturation": 3.14, # Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.
},
"crop": { # Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution. # Specify the video cropping configuration.
"bottomPixels": 42, # The number of pixels to crop from the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to crop from the left. The default is 0.
"rightPixels": 42, # The number of pixels to crop from the right. The default is 0.
"topPixels": 42, # The number of pixels to crop from the top. The default is 0.
},
"deblock": { # Deblock preprocessing configuration. # Deblock preprocessing configuration.
"enabled": True or False, # Enable deblocker. The default is `false`.
"strength": 3.14, # Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.
},
"denoise": { # Denoise preprocessing configuration. # Denoise preprocessing configuration.
"strength": 3.14, # Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
"tune": "A String", # Set the denoiser mode. The default is `"standard"`. Supported denoiser modes: - 'standard' - 'grain'
},
"pad": { # Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution. # Specify the video pad filter configuration.
"bottomPixels": 42, # The number of pixels to add to the bottom. The default is 0.
"leftPixels": 42, # The number of pixels to add to the left. The default is 0.
"rightPixels": 42, # The number of pixels to add to the right. The default is 0.
"topPixels": 42, # The number of pixels to add to the top. The default is 0.
},
},
"uri": "A String", # URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.
},
],
"manifests": [ # List of output manifests.
{ # Manifest configuration.
"fileName": "A String", # The name of the generated file. The default is `"manifest"` with the extension suffix corresponding to the `Manifest.type`.
"muxStreams": [ # Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
"A String",
],
"type": "A String", # Required. Type of the manifest, can be "HLS" or "DASH".
},
],
"muxStreams": [ # List of multiplexing settings for output streams.
{ # Multiplexing settings for output stream.
"container": "A String", # The container format. The default is `"mp4"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `".m4s"` - 'mp4' - 'vtt'
"elementaryStreams": [ # List of `ElementaryStream.key`s multiplexed in this stream.
"A String",
],
"encryption": { # Encryption settings. # Encryption settings.
"aes128": { # Configuration for AES-128 encryption. # Configuration for AES-128 encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
"iv": "A String", # Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits.
"key": "A String", # Required. 128 bit encryption key represented as lowercase hexadecimal digits.
"mpegCenc": { # Configuration for MPEG Common Encryption (MPEG-CENC). # Configuration for MPEG Common Encryption (MPEG-CENC).
"keyId": "A String", # Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption.
"scheme": "A String", # Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'
},
"sampleAes": { # Configuration for SAMPLE-AES encryption. # Configuration for SAMPLE-AES encryption.
"keyUri": "A String", # Required. URI of the key delivery service. This URI is inserted into the M3U8 header.
},
},
"fileName": "A String", # The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"mux_stream0000000123.ts"`.
"key": "A String", # A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `".m3u8"` extension suffix.
"segmentSettings": { # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`. # Segment settings for `"ts"`, `"fmp4"` and `"vtt"`.
"individualSegments": True or False, # Required. Create an individual segment file. The default is `false`.
"segmentDuration": "A String", # Duration of the segments in seconds. The default is `"6.0s"`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).
},
},
],
"output": { # Location of output file(s) in a Cloud Storage bucket. # Output configuration.
"uri": "A String", # URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.
},
"overlays": [ # List of overlays on the output video, in descending Z-order.
{ # Overlay configuration.
"animations": [ # List of Animations. The list should be chronological, without any time overlap.
{ # Animation types.
"animationEnd": { # End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video. # End previous animation.
"startTimeOffset": "A String", # The time to end overlay object, in seconds. Default: 0
},
"animationFade": { # Display overlay object with fade animation. # Display overlay object with fade animation.
"endTimeOffset": "A String", # The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
"fadeType": "A String", # Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
"startTimeOffset": "A String", # The time to start the fade animation, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
"animationStatic": { # Display static overlay object. # Display static overlay object.
"startTimeOffset": "A String", # The time to start displaying the overlay object, in seconds. Default: 0
"xy": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
},
},
],
"image": { # Overlaid jpeg image. # Image overlay.
"alpha": 3.14, # Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
"resolution": { # 2D normalized coordinates. Default: `{0.0, 0.0}` # Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
"x": 3.14, # Normalized x coordinate.
"y": 3.14, # Normalized y coordinate.
},
"uri": "A String", # Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.
},
},
],
"pubsubDestination": { # A Pub/Sub destination. # Destination on Pub/Sub.
"topic": "A String", # The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.
},
"spriteSheets": [ # List of output sprite sheets.
{ # Sprite sheet configuration.
"columnCount": 42, # The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
"endTimeOffset": "A String", # End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
"filePrefix": "A String", # Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `"sprite_sheet0000000123.jpeg"`.
"format": "A String", # Format type. The default is `"jpeg"`. Supported formats: - 'jpeg'
"interval": "A String", # Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
"quality": 42, # The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
"rowCount": 42, # The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
"spriteHeightPixels": 42, # Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).
"spriteWidthPixels": 42, # Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).
"startTimeOffset": "A String", # Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
"totalCount": 42, # Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
},
],
},
"createTime": "A String", # Output only. The time the job was created.
"endTime": "A String", # Output only. The time the transcoding finished.
"failureDetails": [ # Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.
{ # Additional information about the reasons for the failure.
"description": "A String", # A description of the failure.
},
],
"failureReason": "A String", # Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.
"inputUri": "A String", # Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).
"name": "A String", # The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`
"originUri": { # The origin URI. # Output only. The origin URI. *Note*: This feature is not yet available.
"dash": "A String", # Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.
"hls": "A String", # HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.
},
"outputUri": "A String", # Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.
"priority": 42, # Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.
"progress": { # Estimated fractional progress for each step, from `0` to `1`. # Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.
"analyzed": 3.14, # Estimated fractional progress for `analyzing` step.
"encoded": 3.14, # Estimated fractional progress for `encoding` step.
"notified": 3.14, # Estimated fractional progress for `notifying` step.
"uploaded": 3.14, # Estimated fractional progress for `uploading` step.
},
"startTime": "A String", # Output only. The time the transcoding started.
"state": "A String", # Output only. The current state of the job.
"templateId": "A String", # Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
"ttlAfterCompletionDays": 42, # Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.
},
],
"nextPageToken": "A String", # The pagination token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
