Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class TextStream.
Encoding of a text stream. For example, closed captions or subtitles.
Generated from protobuf message google.cloud.video.transcoder.v1.TextStream
Namespace
Google \ Cloud \ Video \ Transcoder \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description | 
| data | arrayOptional. Data for populating the Message object. | 
| ↳ codec | stringThe codec for this text stream. The default is  | 
| ↳ language_code | stringThe BCP-47 language code, such as  | 
| ↳ mapping | array<TextStream\TextMapping>The mapping for the JobConfig.edit_list atoms with text EditAtom.inputs. | 
| ↳ display_name | stringThe name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. | 
getCodec
The codec for this text stream. The default is webvtt.
Supported text codecs:
- srt
- ttml
- cea608
- cea708
- webvtt
| Returns | |
|---|---|
| Type | Description | 
| string | |
setCodec
The codec for this text stream. The default is webvtt.
Supported text codecs:
- srt
- ttml
- cea608
- cea708
- webvtt
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getLanguageCode
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. Not
supported in MP4 files.
| Returns | |
|---|---|
| Type | Description | 
| string | |
setLanguageCode
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. Not
supported in MP4 files.
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getMapping
The mapping for the JobConfig.edit_list atoms with text EditAtom.inputs.
| Returns | |
|---|---|
| Type | Description | 
| Google\Protobuf\Internal\RepeatedField | |
setMapping
The mapping for the JobConfig.edit_list atoms with text EditAtom.inputs.
| Parameter | |
|---|---|
| Name | Description | 
| var | array<TextStream\TextMapping> | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getDisplayName
The name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files.
| Returns | |
|---|---|
| Type | Description | 
| string | |
setDisplayName
The name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files.
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |