Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class TextStream.
Encoding of a text stream. For example, closed captions or subtitles.
Generated from protobuf message google.cloud.video.livestream.v1.TextStream
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ codec |
string
Required. The codec for this text stream. Supported text codecs: - |
↳ language_code |
string
Optional. The BCP-47 language code, such as |
↳ display_name |
string
Optional. The name for this particular text stream that will be added to the HLS/DASH manifest. |
↳ output_cea_channel |
string
Optional. The channel of the closed caption in the output stream. This field should only be set when textstream is used for partner distribution. Must be one of |
↳ mapping |
array<TextStream\TextMapping>
Optional. The mapping for the input streams and text tracks. |
getCodec
Required. The codec for this text stream.
Supported text codecs:
cea608cea708webvtt
| Returns | |
|---|---|
| Type | Description |
string |
|
setCodec
Required. The codec for this text stream.
Supported text codecs:
cea608cea708webvtt
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLanguageCode
Optional. 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
Optional. 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 |
|
getDisplayName
Optional. The name for this particular text stream that will be added to the HLS/DASH manifest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. 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 |
|
getOutputCeaChannel
Optional. The channel of the closed caption in the output stream.
This field should only be set when textstream is used for partner
distribution.
Must be one of CC1, CC2, CC3, and CC4, if the
codec is cea608;
Must be one between SERVICE1 and SERVICE63, if the
codec is cea708.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOutputCeaChannel
Optional. The channel of the closed caption in the output stream.
This field should only be set when textstream is used for partner
distribution.
Must be one of CC1, CC2, CC3, and CC4, if the
codec is cea608;
Must be one between SERVICE1 and SERVICE63, if the
codec is cea708.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMapping
Optional. The mapping for the input streams and text tracks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMapping
Optional. The mapping for the input streams and text tracks.
| Parameter | |
|---|---|
| Name | Description |
var |
array<TextStream\TextMapping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|