Class CaptionSnippet

Basic details about a caption track, such as its language and name.

Inheritance

object

CaptionSnippet

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.YouTube.v3.Data

Assembly: Google.Apis.YouTube.v3.dll

Syntax

public class CaptionSnippet : IDirectResponseSchema

Properties

AudioTrackType

The type of audio track associated with the caption track.

Declaration

[JsonProperty("audioTrackType")]
public virtual string AudioTrackType { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
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.

Declaration

[JsonProperty("failureReason")]
public virtual string FailureReason { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("isAutoSynced")]
public virtual bool? IsAutoSynced { get; set; }

Property Value

Type	Description
bool?

IsCC

Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.

Declaration

[JsonProperty("isCC")]
public virtual bool? IsCC { get; set; }

Property Value

Type	Description
bool?

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. @mutable youtube.captions.insert youtube.captions.update

Declaration

[JsonProperty("isDraft")]
public virtual bool? IsDraft { get; set; }

Property Value

Type	Description
bool?

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.

Declaration

[JsonProperty("isEasyReader")]
public virtual bool? IsEasyReader { get; set; }

Property Value

Type	Description
bool?

IsLarge

Indicates whether the caption track uses large text for the vision-impaired. The default value is false.

Declaration

[JsonProperty("isLarge")]
public virtual bool? IsLarge { get; set; }

Property Value

Type	Description
bool?

Language

The language of the caption track. The property value is a BCP-47 language tag.

Declaration

[JsonProperty("language")]
public virtual string Language { get; set; }

Property Value

Type	Description
string

LastUpdated

DateTime representation of LastUpdatedRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastUpdatedDateTimeOffset instead.")]
public virtual DateTime? LastUpdated { get; set; }

Property Value

Type	Description
DateTime?

LastUpdatedDateTimeOffset

DateTimeOffset representation of LastUpdatedRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? LastUpdatedDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

LastUpdatedRaw

The date and time when the caption track was last updated.

Declaration

[JsonProperty("lastUpdated")]
public virtual string LastUpdatedRaw { get; set; }

Property Value

Type	Description
string

Name

The name of the caption track. The name is intended to be visible to the user as an option during playback.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Status

The caption track's status.

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

TrackKind

The caption track's type.

Declaration

[JsonProperty("trackKind")]
public virtual string TrackKind { get; set; }

Property Value

Type	Description
string

VideoId

The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert

Declaration

[JsonProperty("videoId")]
public virtual string VideoId { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema