three_play.v3.models package

Submodules

three_play.v3.models.requests module

class three_play.v3.models.requests.SessionWithRetry(auth=None, num_retries=7, backoff_factor=1, additional_status_force_list: Optional[List[int]] = None)[source]

Bases: requests.sessions.Session

three_play.v3.models.three_play_media module

3Play API models.

class three_play.v3.models.three_play_media.AudioDescription(media_file: three_play.v3.models.three_play_media.MediaFile = None, **kwargs)[source]

Bases: object

asset_url(dl_format='mp3')[source]
completed_at: Optional[datetime.datetime] = None
created_at: Optional[datetime.datetime] = None
duration: int
id: str
static is_available(lang: three_play.v3.models.three_play_media.Language)[source]

Check if Audio Description is available for a language.

Currently, 3Play only offers AD for videos in English and Spanish.

language: three_play.v3.models.three_play_media.Language
media_file_id: int
property raw_id: str

Returns the 3Play Id for the Audio Description file

status: three_play.v3.models.three_play_media.TranscriptStatus
type: str = 'Audio Description'
video_id: str
class three_play.v3.models.three_play_media.Language(value)[source]

Bases: enum.Enum

Language names and IDs used in the 3Play API.

CHINESE = 18
ENGLISH = 1
FRENCH = 5
GERMAN = 7
ITALIAN = 8
JAPANESE = 23
SPANISH = 13
class three_play.v3.models.three_play_media.MediaFile(**kwargs)[source]

Bases: object

created_at: datetime.datetime
duration: int
id: int
language: three_play.v3.models.three_play_media.Language
name: str
source: str
updated_at: datetime.datetime
static url(file_id: int) → str[source]
video_id: str
class three_play.v3.models.three_play_media.Transcript(media_file: three_play.v3.models.three_play_media.MediaFile = None, **kwargs)[source]

Bases: object

cancellable: bool
completed_at: Optional[datetime.datetime] = None
created_at: Optional[datetime.datetime] = None
default: bool
duration: int
id: str
language: three_play.v3.models.three_play_media.Language
media_file_id: int
status: three_play.v3.models.three_play_media.TranscriptStatus
transcript_types = {'AsrTranscript': 'ASR', 'ImportedTranscript': 'Transcript (Imported)', 'ReviewedTranscript': 'Transcript (Reviewed)', 'TranscribedTranscript': 'Transcript', 'TranslatedTranscript': 'Translation', 'VendorTranscribedTranscript': 'Transcript (Vendor)'}
type: str
video_id: str
class three_play.v3.models.three_play_media.TranscriptFormat(value)[source]

Bases: enum.Enum

An enumeration.

SRT = 7
class three_play.v3.models.three_play_media.TranscriptStatus(value)[source]

Bases: enum.Enum

Transcript statuses used in the 3Play API.

CANCELLED = 'cancelled'
COMPLETE = 'complete'
IN_PROGRESS = 'in_progress'
PENDING = 'pending'
property title
class three_play.v3.models.three_play_media.TranslationOption(value)[source]

Bases: enum.Enum

Translation Options used in the 3Play API – defaults to the vendor “Gengo - Standard”, which is the cheapest option.

CHINESE_TO_ENGLISH = 285
ENGLISH_TO_CHINESE = 56
ENGLISH_TO_FRENCH = 94
ENGLISH_TO_GERMAN = 97
ENGLISH_TO_ITALIAN = 116
ENGLISH_TO_JAPANESE = 76
ENGLISH_TO_SPANISH = 93
FRENCH_TO_ENGLISH = 290
GERMAN_TO_ENGLISH = 287
ITALIAN_TO_ENGLISH = 294
JAPANESE_TO_ENGLISH = 282
SPANISH_TO_ENGLISH = 132
classmethod get(source_language: three_play.v3.models.three_play_media.Language, target_language: three_play.v3.models.three_play_media.Language) → three_play.v3.models.three_play_media.TranslationOption[source]

Return the translation option from source to target language.

class three_play.v3.models.three_play_media.Turnaround(value)[source]

Bases: three_play.v3.models.three_play_media.TurnaroundBase

Turnaround levels and IDs used in the 3Play API.

EXPEDITED = 4
EXTENDED = 5
RUSH = 3
SAME_DAY = 2
STANDARD = 1
TWO_HOUR = 6
class three_play.v3.models.three_play_media.TurnaroundAD(value)[source]

Bases: three_play.v3.models.three_play_media.TurnaroundBase

Turnaround levels and IDs for the Audio Description service.

EXPEDITED = 8
RUSH = 9
STANDARD = 7

Module contents