Class: Google::Apis::YoutubePartnerV1::CuepointSettings

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

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) ⇒ CuepointSettings

Returns a new instance of CuepointSettings.


1632
1633
1634
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1632

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

Instance Attribute Details

#cue_typeString

The cuepoint's type. See the Getting started guide for an explanation of the different types of cuepoints. Also see the Life of a broadcast document for best practices about inserting cuepoints during your broadcast. Corresponds to the JSON property cueType

Returns:

  • (String)

1601
1602
1603
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1601

def cue_type
  @cue_type
end

#duration_secsFixnum

The cuepoint's duration, in seconds. This value must be specified if the cueType is ad and is ignored otherwise. Corresponds to the JSON property durationSecs

Returns:

  • (Fixnum)

1607
1608
1609
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1607

def duration_secs
  @duration_secs
end

#offset_time_msString

This value specifies a point in time in the video when viewers should see an ad or in-stream slate. The property value identifies a time offset, in milliseconds, from the beginning of the monitor stream. Though measured in milliseconds, the value is actually an approximation, and YouTube will insert the cuepoint as closely as possible to that time. You should not specify a value for this parameter if your broadcast does not have a monitor stream. This property's default value is 0, which indicates that the cuepoint should be inserted as soon as possible. If your broadcast stream is not delayed, then 0 is also the only valid value. However, if your broadcast stream is delayed, then the property value can specify the time when the cuepoint should be inserted. See the Getting started guide for more details. Note: If your broadcast had a testing phase, the offset is measured from the time that the testing phase began. Corresponds to the JSON property offsetTimeMs

Returns:

  • (String)

1624
1625
1626
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1624

def offset_time_ms
  @offset_time_ms
end

#walltimeDateTime

This value specifies the wall clock time at which the cuepoint should be inserted. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. Corresponds to the JSON property walltime

Returns:

  • (DateTime)

1630
1631
1632
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1630

def walltime
  @walltime
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1637
1638
1639
1640
1641
1642
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 1637

def update!(**args)
  @cue_type = args[:cue_type] if args.key?(:cue_type)
  @duration_secs = args[:duration_secs] if args.key?(:duration_secs)
  @offset_time_ms = args[:offset_time_ms] if args.key?(:offset_time_ms)
  @walltime = args[:walltime] if args.key?(:walltime)
end