Enums

class ayt_api.enums.LongUploadsStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The eligibility status of the channel to upload videos longer than 15 minutes.

allowed

This channel can upload videos that are more than 15 minutes long.

disallowed

This channel is not able or eligible to upload videos that are more than 15 minutes long.

eligible

This channel is eligible to upload videos that are more than 15 minutes long.

long_uploads_unspecified

YouTube may occasionally return this value if the status is unavailable.

class ayt_api.enums.LiveBroadcastContent(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Indicates if the video is a livestream and if it is live.

live

The video is an active live broadcast.

upcoming

The video is an upcoming broadcast.

none

The video is not an upcoming/active live broadcast.

class ayt_api.enums.VideoDefinition(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Indicates whether the video is available in high definition (HD) or only in standard definition.

hd

The video is available in high definition (HD).

sd

The video is only in standard definition.

class ayt_api.enums.AcbRating(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The video’s Australian Classification Board (ACB) or Australian Communications andMedia Authority (ACMA) rating. ACMA ratings are used to classify children’s television programming.

acb_c

Programs that have been given a C classification by the Australian Communications and Media Authority. These programs are intended for children (other than preschool children) who are younger than 14 years of age.

acb_e

Exempt (E): Some video are exempt from needing to be classified.

acb_g

General (G) The content is very mild in impact. Videos classified G (General) are suitable for everyone. They can have content that may scare very young children.

acb_m

Mature (M): The content is moderate in impact. Videos classified M (Mature) are not recommended for children under the age of 15. They can have content such as violence and themes that requires a mature outlook.

acb_ma15plus

Mature Accompanied (MA 15+): The content is strong in impact. Films and computer games classified MA 15+ are legally restricted to people aged 15 and over. They can contain content such as sex scenes and drug use that may have a strong impact on the viewer.

acb_p

Preschool (P): Programs that have been given a P classification by the Australian Communications and Media Authority. These programs are intended for preschool children.

acb_pg

Parental Guidance (PG): The content is mild in impact. Films and computer games classified PG (Parental Guidance) can have content that a child may find confusing or upsetting and require the guidance of a parent or guardian. It is not recommended for viewing by children under the age of 15 without guidance of a parent or guardian.

acb_r18plus

Restricted (R 18+): The content is high in impact. Films and computer games classified as R 18+ are legally restricted to adults 18 years and over. They can contain content that may be offensive to sections of the adult community.

acb_unrated

No rating is available.

class ayt_api.enums.VideoProjection(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Specifies the projection format of the video (example: 360 or rectangular).

_360

The video is a 360 video that will work with VR headsets.

rectangular

The video is a regular rectangular video.

class ayt_api.enums.UploadStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The status of the uploaded video.

deleted

The upload was deleted.

failed

The upload process failed.

rejected

The upload has been rejected by YouTube.

uploaded

The upload was successful.

class ayt_api.enums.UploadFailureReason(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Explains why a video failed to upload.

codec

The upload has an unsupported codec.

conversion

Converting the upload failed.

empty_file

The upload file is empty.

invalid_file

The upload file is an invalid file type.

too_small

The upload file is too small.

upload_aborted

The upload process was aborted.

class ayt_api.enums.UploadRejectionReason(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Explains why YouTube rejected an uploaded video.

claim

The upload has a copyright claim.

copyright

The upload was rejected due to a copyright takedown request.

duplicate

The upload is a duplicate of an existing upload.

inappropriate

The upload contains inappropriate material not suitable for YouTube.

legal

The upload was rejected for legal reasons.

length

The upload is too long

terms_of_use

The upload violates YouTube’s terms of use.

trademark

The upload was rejected due to trademark reasons.

uploader_account_closed

The account of the uploader is deleted or terminated.

uploader_account_suspended

The account of the uploader is suspended.

class ayt_api.enums.PrivacyStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The video or playlist’s privacy status. Can be private, public or unlisted.

private

The video or playlist is only available to the uploader/owner and people granted access.

public

The video or playlist is visible to everyone.

unlisted

The video or playlist is accessible to anyone with its link.

privacy_status_unspecified

The privacy status of the video is unknown.

class ayt_api.enums.PodcastStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

A playlist’s podcast status.

Added in version 0.4.0.

enabled

The playlist is marked as a podcast show

disabled

the playlist is not marked as a podcast show

unspecified

The podcast status is unspecified.

class ayt_api.enums.License(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The video’s license.

creative_common

The video uses a creative commons license.

youtube

The video uses YouTube’s standard license.

class ayt_api.enums.CaptionStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The caption track’s status.

failed

Processing the caption track failed.

serving

The caption track is currently serving.

syncing

The caption track is currently being synced.

class ayt_api.enums.CaptionFailureReason(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The reason that YouTube failed to process the caption track.

processing_failed

YouTube failed to process the uploaded caption track.

unknown_format

The caption track’s format was not recognized.

unsupported_format

The caption track’s format is not supported.

class ayt_api.enums.AudioTrackType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The type of audio track associated with the caption track.

commentary

The caption track corresponds to an alternate audio track that includes commentary, such as directory commentary.

descriptive

The caption track corresponds to an alternate audio track that includes additional descriptive audio.

primary

The caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video.

unknown

This is the default value.

class ayt_api.enums.CaptionTrackKind(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The caption track’s type.

asr

A caption track generated using automatic speech recognition.

forced

A caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language.

standard

A regular caption track. This is the default value.

class ayt_api.enums.SubscriptionActivityType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The type of activity this subscription is for.

Added in version 0.4.0.

all

This subscription is for everything

uploads

This subscription is specifically for uploads.

class ayt_api.enums.UploadFileType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The uploaded file’s type as detected by YouTube’s video processing engine.

Added in version 0.4.0.

archive

The file is an archive file, such as a .zip archive.

audio

The file is a known audio file type, such as an .mp3 file.

document

The file is a document or text file, such as an MS Word document.

image

The file is an image file, such as a .jpeg image.

other

The file is another non-video file type.

project

The file is a video project file, such as a Microsoft Windows Movie Maker project, that does not contain actual video data.

video

The file is a known video file type, such as an .mp4 file.

class ayt_api.enums.ProcessingStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The video’s processing status.

Added in version 0.4.0.

failed

Video processing has failed. See ProcessingFailureReason.

processing

Video is currently being processed. See ProcessingProgress.

succeeded

Video has been successfully processed.

terminated

Processing information is no longer available.

class ayt_api.enums.ProcessingFailureReason(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The reason that YouTube failed to process the video.

Added in version 0.4.0.

other

Some other processing component has failed.

streaming_failed

Video could not be sent to streamers.

transcode_failed

Content transcoding has failed.

upload_failed

File delivery has failed.

class ayt_api.enums.ProcessingError(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Errors that will prevent YouTube from successfully processing the uploaded video.

Added in version 0.4.0.

archive_file

An archive file (e.g., a ZIP archive).

audio_file

File contains audio only (e.g., an MP3 file).

doc_file

Document or text file (e.g., MS Word document).

image_file

Image file (e.g., a JPEG image).

not_a_video_file

Other non-video file.

project_file

Movie project file (e.g., Microsoft Windows Movie Maker project).

class ayt_api.enums.ProcessingWarning(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding.

Added in version 0.4.0.

has_editlist

Edit lists are not currently supported.

has_edit_list

Alias of has_editlist. Edit lists are not currently supported.

inconsistent_resolution

Conflicting container and stream resolutions.

problematic_audio_codec

Audio codec that is known to cause problems was used.

problematic_video_codec

Video codec that is known to cause problems was used.

unknown_audio_codec

Unrecognized audio codec, transcoding is likely to fail.

unknown_container

Unrecognized file format, transcoding is likely to fail.

unknown_video_codec

Unrecognized video codec, transcoding is likely to fail.

class ayt_api.enums.ProcessingHint(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Suggestions that may improve YouTube’s ability to process the video.

Added in version 0.4.0.

non_streamable_mov

The MP4 file is not streamable, this will slow down the processing.

send_best_quality_video

Probably a better quality version of the video exists.

class ayt_api.enums.EditorSuggestion(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Video editing operations that might improve the video quality or playback experience of the uploaded video.

Added in version 0.4.0.

audio_quiet_audio_swap

The audio track appears silent and could be swapped with a better quality one.

video_auto_levels

Picture brightness levels seem off and could be corrected.

video_crop

Margins (mattes) detected around the picture could be cropped.

video_stabilize

The video appears shaky and could be stabilized.

class ayt_api.enums.OAuth2Scope(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

OAuth2 scopes when using OAuth2 with the library.

youtube

Manage your YouTube account.

youtube_channel_memberships_creator

See a list of your current active channel members, their current level, and when they became a member.

youtube_force_ssl

See, edit, and permanently delete your YouTube videos, ratings, comments and captions.

youtube_readonly

View your YouTube account.

youtube_upload

Manage your YouTube videos.

youtube_partner

View and manage your assets and associated content on YouTube.

youtube_partner_channel_audit

View private information of your YouTube channel relevant during the audit process with a YouTube partner.

classmethod all() → list[OAuth2Scope]

A list of all the available scopes related to the YouTube data api.

Returns:

A list of all the scopes

Return type:

list[OAuth2Scope]

classmethod default() → list[OAuth2Scope]

A list of scopes used by this library by default.

Returns:

A list of all the scopes

Return type:

list[OAuth2Scope]

class ayt_api.enums.CaptionFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The available caption formats YouTube support.

sbv

SubViewer subtitle.

scc

Scenarist Closed Caption format.

srt

SubRip subtitle.

ttml

Timed Text Markup Language caption.

vtt

Web Video Text Tracks caption.

class ayt_api.enums.WatermarkTimingType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

The timing method that determines when the watermark image is displayed during the video playback.

offset_from_start

The offset is from the start of the video.

offset_from_end

The offset is from the end of the video.