Class: Google::Apis::YoutubeV3::LiveBroadcastContentDetails

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/google/apis/youtube_v3/representations.rb

Overview

Detailed settings of a broadcast.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LiveBroadcastContentDetails

Returns a new instance of LiveBroadcastContentDetails



3817
3818
3819
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3817

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bound_stream_id ⇒ String

This value uniquely identifies the live stream bound to the broadcast. Corresponds to the JSON property boundStreamId

Returns:

  • (String) 


3729
3730
3731
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3729

def bound_stream_id
  @bound_stream_id
end

#bound_stream_last_update_time_ms ⇒ DateTime

The date and time that the live stream referenced by boundStreamId was last updated. Corresponds to the JSON property boundStreamLastUpdateTimeMs

Returns:

  • (DateTime) 


3735
3736
3737
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3735

def bound_stream_last_update_time_ms
  @bound_stream_last_update_time_ms
end

#closed_captions_type ⇒ String

Corresponds to the JSON property closedCaptionsType

Returns:

  • (String) 


3740
3741
3742
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3740

def closed_captions_type
  @closed_captions_type
end

#enable_closed_captions ⇒ Boolean Also known as: enable_closed_captions?

This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. Corresponds to the JSON property enableClosedCaptions

Returns:

  • (Boolean) 


3749
3750
3751
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3749

def enable_closed_captions
  @enable_closed_captions
end

#enable_content_encryption ⇒ Boolean Also known as: enable_content_encryption?

This setting indicates whether YouTube should enable content encryption for the broadcast. Corresponds to the JSON property enableContentEncryption

Returns:

  • (Boolean) 


3756
3757
3758
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3756

def enable_content_encryption
  @enable_content_encryption
end

#enable_dvr ⇒ Boolean Also known as: enable_dvr?

This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends. Corresponds to the JSON property enableDvr

Returns:

  • (Boolean) 


3768
3769
3770
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3768

def enable_dvr
  @enable_dvr
end

#enable_embed ⇒ Boolean Also known as: enable_embed?

This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. Corresponds to the JSON property enableEmbed

Returns:

  • (Boolean) 


3776
3777
3778
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3776

def enable_embed
  @enable_embed
end

#enable_low_latency ⇒ Boolean Also known as: enable_low_latency?

Indicates whether this broadcast has low latency enabled. Corresponds to the JSON property enableLowLatency

Returns:

  • (Boolean) 


3782
3783
3784
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3782

def enable_low_latency
  @enable_low_latency
end

#monitor_stream ⇒ Google::Apis::YoutubeV3::MonitorStreamInfo

Settings and Info of the monitor stream Corresponds to the JSON property monitorStream

Returns:



3788
3789
3790
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3788

def monitor_stream
  @monitor_stream
end

#projection ⇒ String

The projection format of this broadcast. This defaults to rectangular. Corresponds to the JSON property projection

Returns:

  • (String) 


3793
3794
3795
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3793

def projection
  @projection
end

#record_from_start ⇒ Boolean Also known as: record_from_start?

Automatically start recording after the event goes live. The default value for this property is true. Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback. Corresponds to the JSON property recordFromStart

Returns:

  • (Boolean) 


3804
3805
3806
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3804

def record_from_start
  @record_from_start
end

#start_with_slate ⇒ Boolean Also known as: start_with_slate?

This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. Corresponds to the JSON property startWithSlate

Returns:

  • (Boolean) 


3814
3815
3816
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3814

def start_with_slate
  @start_with_slate
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 3822

def update!(**args)
  @bound_stream_id = args[:bound_stream_id] if args.key?(:bound_stream_id)
  @bound_stream_last_update_time_ms = args[:bound_stream_last_update_time_ms] if args.key?(:bound_stream_last_update_time_ms)
  @closed_captions_type = args[:closed_captions_type] if args.key?(:closed_captions_type)
  @enable_closed_captions = args[:enable_closed_captions] if args.key?(:enable_closed_captions)
  @enable_content_encryption = args[:enable_content_encryption] if args.key?(:enable_content_encryption)
  @enable_dvr = args[:enable_dvr] if args.key?(:enable_dvr)
  @enable_embed = args[:enable_embed] if args.key?(:enable_embed)
  @enable_low_latency = args[:enable_low_latency] if args.key?(:enable_low_latency)
  @monitor_stream = args[:monitor_stream] if args.key?(:monitor_stream)
  @projection = args[:projection] if args.key?(:projection)
  @record_from_start = args[:record_from_start] if args.key?(:record_from_start)
  @start_with_slate = args[:start_with_slate] if args.key?(:start_with_slate)
end