Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::TextStream (v2.5.0)

Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::TextStream.

Encoding of a text stream. For example, closed captions or subtitles.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#codec

def codec() -> ::String

Returns

(::String) —
Required. The codec for this text stream.

Supported text codecs:
- cea608
- cea708
- webvtt

#codec=

def codec=(value) -> ::String

Parameter

value (::String) —
Required. The codec for this text stream.

Supported text codecs:
- cea608
- cea708
- webvtt

Returns

(::String) —
Required. The codec for this text stream.

Supported text codecs:
- cea608
- cea708
- webvtt

#display_name

def display_name() -> ::String

Returns

(::String) — Optional. The name for this particular text stream that will be added to the HLS/DASH manifest.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Optional. The name for this particular text stream that will be added to the HLS/DASH manifest.

Returns

(::String) — Optional. The name for this particular text stream that will be added to the HLS/DASH manifest.

#language_code

def language_code() -> ::String

Returns

(::String) — 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.

#language_code=

def language_code=(value) -> ::String

Parameter

value (::String) — 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

(::String) — 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.

#mapping

def mapping() -> ::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>) — Optional. The mapping for the input streams and text tracks.

#mapping=

def mapping=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>

Parameter

value (::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>) — Optional. The mapping for the input streams and text tracks.

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>) — Optional. The mapping for the input streams and text tracks.

#output_cea_channel

def output_cea_channel() -> ::String

Returns

(::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 CC1, CC2, CC3, and CC4, if the codec is cea608; Must be one between SERVICE1 and SERVICE63, if the codec is cea708.

#output_cea_channel=

def output_cea_channel=(value) -> ::String

Parameter

value (::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 CC1, CC2, CC3, and CC4, if the codec is cea608; Must be one between SERVICE1 and SERVICE63, if the codec is cea708.

Returns

(::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 CC1, CC2, CC3, and CC4, if the codec is cea608; Must be one between SERVICE1 and SERVICE63, if the codec is cea708.