google_api_you_tube v0.21.0 GoogleApi.YouTube.V3.Model.CaptionSnippet View Source
Basic details about a caption track, such as its language and name.
Attributes
-
audioTrackType
(type:String.t
, default:nil
) - The type of audio track associated with the caption track. -
failureReason
(type:String.t
, default:nil
) - The reason that YouTube failed to process the caption track. This property is only present if the <code><a href="#state">state</a></code> property's value is <code>failed</code>. -
isAutoSynced
(type:boolean()
, default:nil
) - Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be <code>true</code> if a sync was explicitly requested when the caption track was uploaded. For example, when calling the <code>captions.insert</code> or <code>captions.update</code> methods, you can set the <code>sync</code> parameter to <code>true</code> to instruct YouTube to sync the uploaded track to the video. If the value is <code>false</code>, YouTube uses the time codes in the uploaded caption track to determine when to display captions. -
isCC
(type:boolean()
, default:nil
) - Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is <code>false</code>. -
isDraft
(type:boolean()
, default:nil
) - Indicates whether the caption track is a draft. If the value is <code>true</code>, then the track is not publicly visible. The default value is <code>false</code>. @mutable youtube.captions.insert youtube.captions.update -
isEasyReader
(type:boolean()
, default:nil
) - Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is <code>false</code>. -
isLarge
(type:boolean()
, default:nil
) - Indicates whether the caption track uses large text for the vision-impaired. The default value is <code>false</code>. -
language
(type:String.t
, default:nil
) - The language of the caption track. The property value is a <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a> language tag. -
lastUpdated
(type:String.t
, default:nil
) - The date and time when the caption track was last updated. The value is specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> format. -
name
(type:String.t
, default:nil
) - The name of the caption track. The name is intended to be visible to the user as an option during playback. -
status
(type:String.t
, default:nil
) - The caption track's status. -
trackKind
(type:String.t
, default:nil
) - The caption track's type. -
videoId
(type:String.t
, default:nil
) - The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.YouTube.V3.Model.CaptionSnippet{ audioTrackType: String.t(), failureReason: String.t(), isAutoSynced: boolean(), isCC: boolean(), isDraft: boolean(), isEasyReader: boolean(), isLarge: boolean(), language: String.t(), lastUpdated: String.t(), name: String.t(), status: String.t(), trackKind: String.t(), videoId: String.t() }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.