Module `twitchpy.dataclasses.clip`

Classes

class Clip (clip_id: str, url: str, embed_url: str, channel: Channel, creator: User, video_id: str, game_id: str, language: str, title: str, view_count: int, created_at: str, thumbnail_url: str, duration: float, vod_offset: int, is_featured: bool)

Expand source code

@dataclass
class Clip:
    """
    Represents a clip

    Attributes:
        clip_id (str): An ID that uniquely identifies the clip
        url (str): A URL to the clip
        embed_url (str): A URL that you can use in an iframe to embed the clip
        channel (Channel): The channel that the video was clipped from
        creator (User): The user that created the clip
        video_id (str): An ID that identifies the video that the clip came from
        game_id (str): The ID of the game that was being played when the clip was created
        language (str): The ISO 639-1 two-letter language code that the broadcaster broadcasts in
        title (str): The title of the clip
        view_count (int): The number of times the clip has been viewed
        created_at (str): The date and time of when the clip was created
        thumbnail_url (str): A URL to a thumbnail image of the clip
        duration (float): The length of the clip, in seconds
            Precision is 0.1
        vod_offset (int): The zero-based offset, in seconds, to where the clip starts in the video (VOD)
        is_featured (bool): A Boolean value that indicates if the clip is featured or not
    """

    clip_id: str
    url: str
    embed_url: str
    channel: Channel
    creator: User
    video_id: str
    game_id: str
    language: str
    title: str
    view_count: int
    created_at: str
    thumbnail_url: str
    duration: float
    vod_offset: int
    is_featured: bool

Represents a clip

Attributes

clip_id : str: An ID that uniquely identifies the clip
url : str: A URL to the clip
embed_url : str: A URL that you can use in an iframe to embed the clip
channel : Channel: The channel that the video was clipped from
creator : User: The user that created the clip
video_id : str: An ID that identifies the video that the clip came from
game_id : str: The ID of the game that was being played when the clip was created
language : str: The ISO 639-1 two-letter language code that the broadcaster broadcasts in
title : str: The title of the clip
view_count : int: The number of times the clip has been viewed
created_at : str: The date and time of when the clip was created
thumbnail_url : str: A URL to a thumbnail image of the clip
duration : float: The length of the clip, in seconds Precision is 0.1
vod_offset : int: The zero-based offset, in seconds, to where the clip starts in the video (VOD)
is_featured : bool: A Boolean value that indicates if the clip is featured or not

Class variables

var channel : Channel: The type of the None singleton.
var clip_id : str: The type of the None singleton.
var created_at : str: The type of the None singleton.
var creator : User: The type of the None singleton.
var duration : float: The type of the None singleton.
var embed_url : str: The type of the None singleton.
var game_id : str: The type of the None singleton.
var is_featured : bool: The type of the None singleton.
var language : str: The type of the None singleton.
var thumbnail_url : str: The type of the None singleton.
var title : str: The type of the None singleton.
var url : str: The type of the None singleton.
var video_id : str: The type of the None singleton.
var view_count : int: The type of the None singleton.
var vod_offset : int: The type of the None singleton.