Class: Google::Cloud::Video::LiveStream::V1::TextStream

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/outputs.rb

Overview

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

Defined Under Namespace

Classes: TextMapping

Instance Attribute Summary collapse

Instance Attribute Details

#codec ⇒ ::String

Returns 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


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
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 702

class TextStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and text tracks.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Optional. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this text mapping applies to.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Optional. The zero-based index of the track in the input stream.
  # @!attribute [rw] input_cea_channel
  #   @return [::String]
  #     Optional. The channel of the closed caption in the input stream.
  #     If this field is set, the output
  #     {::Google::Cloud::Video::LiveStream::V1::TextStream#codec codec} must be
  #     `webvtt`. Must be one of `CC1`, `CC2`, `CC3`, and `CC4`, if the codec of
  #     the input closed caption is `cea608`; Must be one between `SERVICE1` and
  #     `SERVICE64`, if the codec of the input closed caption is `cea708`.
  # @!attribute [rw] from_language_code
  #   @return [::String]
  #     Optional. The BCP-47 source language code, such as `en-US` or `sr-Latn`.
  #     If differ from the textStream's language code, enable translation. For
  #     more information on BCP-47 language codes, see
  #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  class TextMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns 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.



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
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 702

class TextStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and text tracks.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Optional. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this text mapping applies to.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Optional. The zero-based index of the track in the input stream.
  # @!attribute [rw] input_cea_channel
  #   @return [::String]
  #     Optional. The channel of the closed caption in the input stream.
  #     If this field is set, the output
  #     {::Google::Cloud::Video::LiveStream::V1::TextStream#codec codec} must be
  #     `webvtt`. Must be one of `CC1`, `CC2`, `CC3`, and `CC4`, if the codec of
  #     the input closed caption is `cea608`; Must be one between `SERVICE1` and
  #     `SERVICE64`, if the codec of the input closed caption is `cea708`.
  # @!attribute [rw] from_language_code
  #   @return [::String]
  #     Optional. The BCP-47 source language code, such as `en-US` or `sr-Latn`.
  #     If differ from the textStream's language code, enable translation. For
  #     more information on BCP-47 language codes, see
  #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  class TextMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_code ⇒ ::String

Returns 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:



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
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 702

class TextStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and text tracks.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Optional. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this text mapping applies to.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Optional. The zero-based index of the track in the input stream.
  # @!attribute [rw] input_cea_channel
  #   @return [::String]
  #     Optional. The channel of the closed caption in the input stream.
  #     If this field is set, the output
  #     {::Google::Cloud::Video::LiveStream::V1::TextStream#codec codec} must be
  #     `webvtt`. Must be one of `CC1`, `CC2`, `CC3`, and `CC4`, if the codec of
  #     the input closed caption is `cea608`; Must be one between `SERVICE1` and
  #     `SERVICE64`, if the codec of the input closed caption is `cea708`.
  # @!attribute [rw] from_language_code
  #   @return [::String]
  #     Optional. The BCP-47 source language code, such as `en-US` or `sr-Latn`.
  #     If differ from the textStream's language code, enable translation. For
  #     more information on BCP-47 language codes, see
  #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  class TextMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#mapping ⇒ ::Array<::Google::Cloud::Video::LiveStream::V1::TextStream::TextMapping>

Returns Optional. The mapping for the input streams and text tracks.

Returns:



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
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 702

class TextStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and text tracks.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Optional. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this text mapping applies to.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Optional. The zero-based index of the track in the input stream.
  # @!attribute [rw] input_cea_channel
  #   @return [::String]
  #     Optional. The channel of the closed caption in the input stream.
  #     If this field is set, the output
  #     {::Google::Cloud::Video::LiveStream::V1::TextStream#codec codec} must be
  #     `webvtt`. Must be one of `CC1`, `CC2`, `CC3`, and `CC4`, if the codec of
  #     the input closed caption is `cea608`; Must be one between `SERVICE1` and
  #     `SERVICE64`, if the codec of the input closed caption is `cea708`.
  # @!attribute [rw] from_language_code
  #   @return [::String]
  #     Optional. The BCP-47 source language code, such as `en-US` or `sr-Latn`.
  #     If differ from the textStream's language code, enable translation. For
  #     more information on BCP-47 language codes, see
  #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  class TextMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#output_cea_channel ⇒ ::String

Returns 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.



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
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 702

class TextStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and text tracks.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Optional. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this text mapping applies to.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Optional. The zero-based index of the track in the input stream.
  # @!attribute [rw] input_cea_channel
  #   @return [::String]
  #     Optional. The channel of the closed caption in the input stream.
  #     If this field is set, the output
  #     {::Google::Cloud::Video::LiveStream::V1::TextStream#codec codec} must be
  #     `webvtt`. Must be one of `CC1`, `CC2`, `CC3`, and `CC4`, if the codec of
  #     the input closed caption is `cea608`; Must be one between `SERVICE1` and
  #     `SERVICE64`, if the codec of the input closed caption is `cea708`.
  # @!attribute [rw] from_language_code
  #   @return [::String]
  #     Optional. The BCP-47 source language code, such as `en-US` or `sr-Latn`.
  #     If differ from the textStream's language code, enable translation. For
  #     more information on BCP-47 language codes, see
  #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  class TextMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end