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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ codec |
string
The codec for this text stream. The default is |
↳ language_code |
string
The BCP-47 language code, such as |
↳ mapping |
array<Google\Cloud\Video\Transcoder\V1\TextStream\TextMapping>
The mapping for the |
↳ display_name |
string
The name for this particular text stream that will be added to the HLS/DASH manifest. |
getCodec
The codec for this text stream. The default is webvtt.
Supported text codecs:
srtttmlcea608cea708webvtt
| Returns | |
|---|---|
| Type | Description |
string | |
setCodec
The codec for this text stream. The default is webvtt.
Supported text codecs:
srtttmlcea608cea708webvtt
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMapping
The mapping for the Job.edit_list atoms with text EditAtom.inputs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMapping
The mapping for the Job.edit_list atoms with text EditAtom.inputs.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\Transcoder\V1\TextStream\TextMapping>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The name for this particular text stream that will be added to the HLS/DASH manifest.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The name for this particular text stream that will be added to the HLS/DASH manifest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |