CaptionSnippet (YouTube Data API v3 (Rev. 222) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.youtube.model.CaptionSnippet

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class CaptionSnippet
extends com.google.api.client.json.GenericJson
```
Basic details about a caption track, such as its language and name.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the YouTube Data API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

CaptionSnippet()

Constructors
Constructor and Description
`CaptionSnippet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CaptionSnippet`	`clone()`
`java.lang.String`	`getAudioTrackType()` The type of audio track associated with the caption track.
`java.lang.String`	`getFailureReason()` The reason that YouTube failed to process the caption track.
`java.lang.Boolean`	`getIsAutoSynced()` Indicates whether YouTube synchronized the caption track to the audio track in the video.
`java.lang.Boolean`	`getIsCC()` Indicates whether the track contains closed captions for the deaf and hard of hearing.
`java.lang.Boolean`	`getIsDraft()` Indicates whether the caption track is a draft.
`java.lang.Boolean`	`getIsEasyReader()` Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners.
`java.lang.Boolean`	`getIsLarge()` Indicates whether the caption track uses large text for the vision-impaired.
`java.lang.String`	`getLanguage()` The language of the caption track.
`com.google.api.client.util.DateTime`	`getLastUpdated()` The date and time when the caption track was last updated.
`java.lang.String`	`getName()` The name of the caption track.
`java.lang.String`	`getStatus()` The caption track's status.
`java.lang.String`	`getTrackKind()` The caption track's type.
`java.lang.String`	`getVideoId()` The ID that YouTube uses to uniquely identify the video associated with the caption track.
`CaptionSnippet`	`set(java.lang.String fieldName, java.lang.Object value)`
`CaptionSnippet`	`setAudioTrackType(java.lang.String audioTrackType)` The type of audio track associated with the caption track.
`CaptionSnippet`	`setFailureReason(java.lang.String failureReason)` The reason that YouTube failed to process the caption track.
`CaptionSnippet`	`setIsAutoSynced(java.lang.Boolean isAutoSynced)` Indicates whether YouTube synchronized the caption track to the audio track in the video.
`CaptionSnippet`	`setIsCC(java.lang.Boolean isCC)` Indicates whether the track contains closed captions for the deaf and hard of hearing.
`CaptionSnippet`	`setIsDraft(java.lang.Boolean isDraft)` Indicates whether the caption track is a draft.
`CaptionSnippet`	`setIsEasyReader(java.lang.Boolean isEasyReader)` Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners.
`CaptionSnippet`	`setIsLarge(java.lang.Boolean isLarge)` Indicates whether the caption track uses large text for the vision-impaired.
`CaptionSnippet`	`setLanguage(java.lang.String language)` The language of the caption track.
`CaptionSnippet`	`setLastUpdated(com.google.api.client.util.DateTime lastUpdated)` The date and time when the caption track was last updated.
`CaptionSnippet`	`setName(java.lang.String name)` The name of the caption track.
`CaptionSnippet`	`setStatus(java.lang.String status)` The caption track's status.
`CaptionSnippet`	`setTrackKind(java.lang.String trackKind)` The caption track's type.
`CaptionSnippet`	`setVideoId(java.lang.String videoId)` The ID that YouTube uses to uniquely identify the video associated with the caption track.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - CaptionSnippet
```
public CaptionSnippet()
```
- Method Detail
  - getAudioTrackType
```
public java.lang.String getAudioTrackType()
```
    The type of audio track associated with the caption track.
    
    Returns:
    
    value or null for none
  - setAudioTrackType
```
public CaptionSnippet setAudioTrackType(java.lang.String audioTrackType)
```
    The type of audio track associated with the caption track.
    
    Parameters:
    
    audioTrackType - audioTrackType or null for none
  - getFailureReason
```
public java.lang.String getFailureReason()
```
    The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
    
    Returns:
    
    value or null for none
  - setFailureReason
```
public CaptionSnippet setFailureReason(java.lang.String failureReason)
```
    The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
    
    Parameters:
    
    failureReason - failureReason or null for none
  - getIsAutoSynced
```
public java.lang.Boolean getIsAutoSynced()
```
    Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
    
    Returns:
    
    value or null for none
  - setIsAutoSynced
```
public CaptionSnippet setIsAutoSynced(java.lang.Boolean isAutoSynced)
```
    Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
    
    Parameters:
    
    isAutoSynced - isAutoSynced or null for none
  - getIsCC
```
public java.lang.Boolean getIsCC()
```
    Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
    
    Returns:
    
    value or null for none
  - setIsCC
```
public CaptionSnippet setIsCC(java.lang.Boolean isCC)
```
    Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
    
    Parameters:
    
    isCC - isCC or null for none
  - getIsDraft
```
public java.lang.Boolean getIsDraft()
```
    Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
    
    Returns:
    
    value or null for none
  - setIsDraft
```
public CaptionSnippet setIsDraft(java.lang.Boolean isDraft)
```
    Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
    
    Parameters:
    
    isDraft - isDraft or null for none
  - getIsEasyReader
```
public java.lang.Boolean getIsEasyReader()
```
    Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
    
    Returns:
    
    value or null for none
  - setIsEasyReader
```
public CaptionSnippet setIsEasyReader(java.lang.Boolean isEasyReader)
```
    Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
    
    Parameters:
    
    isEasyReader - isEasyReader or null for none
  - getIsLarge
```
public java.lang.Boolean getIsLarge()
```
    Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
    
    Returns:
    
    value or null for none
  - setIsLarge
```
public CaptionSnippet setIsLarge(java.lang.Boolean isLarge)
```
    Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
    
    Parameters:
    
    isLarge - isLarge or null for none
  - getLanguage
```
public java.lang.String getLanguage()
```
    The language of the caption track. The property value is a BCP-47 language tag.
    
    Returns:
    
    value or null for none
  - setLanguage
```
public CaptionSnippet setLanguage(java.lang.String language)
```
    The language of the caption track. The property value is a BCP-47 language tag.
    
    Parameters:
    
    language - language or null for none
  - getLastUpdated
```
public com.google.api.client.util.DateTime getLastUpdated()
```
    The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    
    Returns:
    
    value or null for none
  - setLastUpdated
```
public CaptionSnippet setLastUpdated(com.google.api.client.util.DateTime lastUpdated)
```
    The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
    
    Parameters:
    
    lastUpdated - lastUpdated or null for none
  - getName
```
public java.lang.String getName()
```
    The name of the caption track. The name is intended to be visible to the user as an option during playback.
    
    Returns:
    
    value or null for none
  - setName
```
public CaptionSnippet setName(java.lang.String name)
```
    The name of the caption track. The name is intended to be visible to the user as an option during playback.
    
    Parameters:
    
    name - name or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    The caption track's status.
    
    Returns:
    
    value or null for none
  - setStatus
```
public CaptionSnippet setStatus(java.lang.String status)
```
    The caption track's status.
    
    Parameters:
    
    status - status or null for none
  - getTrackKind
```
public java.lang.String getTrackKind()
```
    The caption track's type.
    
    Returns:
    
    value or null for none
  - setTrackKind
```
public CaptionSnippet setTrackKind(java.lang.String trackKind)
```
    The caption track's type.
    
    Parameters:
    
    trackKind - trackKind or null for none
  - getVideoId
```
public java.lang.String getVideoId()
```
    The ID that YouTube uses to uniquely identify the video associated with the caption track.
    
    Returns:
    
    value or null for none
  - setVideoId
```
public CaptionSnippet setVideoId(java.lang.String videoId)
```
    The ID that YouTube uses to uniquely identify the video associated with the caption track.
    
    Parameters:
    
    videoId - videoId or null for none
  - set
```
public CaptionSnippet set(java.lang.String fieldName,
                          java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CaptionSnippet clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

YouTube Data API v3 (revision 222)

Class CaptionSnippet

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CaptionSnippet

Method Detail

getAudioTrackType

setAudioTrackType

getFailureReason

setFailureReason

getIsAutoSynced

setIsAutoSynced

getIsCC

setIsCC

getIsDraft

setIsDraft

getIsEasyReader

setIsEasyReader

getIsLarge

setIsLarge

getLanguage

setLanguage

getLastUpdated

setLastUpdated

getName

setName

getStatus

setStatus

getTrackKind

setTrackKind

getVideoId

setVideoId

set

clone