Module twitchpy.dataclasses.stream

Classes

class Stream (stream_id: str,
channel: Channel,
game: Game,
stream_type: str,
title: str,
tags: list[str],
viewer_count: int,
started_at: datetime.datetime,
language: str,
thumbnail_url: str,
is_mature: bool)

Expand source code

@dataclass
class Stream:
    """
    Represents a stream

    Attributes:
        stream_id (str): An ID that identifies the stream
        channel (Channel): The channel that is broadcasting the stream
        game (Game): The category or game being played
        stream_type (str): The type of stream
        title (str): The stream’s title
        tags (list[str]): The tags applied to the stream
        viewer_count (int): The number of users watching the stream
        started_at (str): The UTC date and time (in RFC3339 format) of when the broadcast began
        language (str): The language that the stream uses
        thumbnail_url (str): A URL to an image of a frame from the last 5 minutes of the stream
        is_mature (bool): A Boolean value that indicates whether the stream is meant for mature audiences
    """

    stream_id: str
    channel: Channel
    game: Game
    stream_type: str
    title: str
    tags: list[str]
    viewer_count: int
    started_at: datetime
    language: str
    thumbnail_url: str
    is_mature: bool

Represents a stream

Attributes

stream_id : str

An ID that identifies the stream

channel : Channel

The channel that is broadcasting the stream

game : Game

The category or game being played

stream_type : str

The type of stream

title : str

The stream’s title

tags : list[str]

The tags applied to the stream

viewer_count : int

The number of users watching the stream

started_at : str

The UTC date and time (in RFC3339 format) of when the broadcast began

language : str

The language that the stream uses

thumbnail_url : str

A URL to an image of a frame from the last 5 minutes of the stream

is_mature : bool

A Boolean value that indicates whether the stream is meant for mature audiences

Class variables

var channel : Channel

The type of the None singleton.

var game : Game

The type of the None singleton.

var is_mature : bool

The type of the None singleton.

var language : str

The type of the None singleton.

var started_at : datetime.datetime

The type of the None singleton.

var stream_id : str

The type of the None singleton.

var stream_type : str

The type of the None singleton.

var tags : list[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 viewer_count : int

The type of the None singleton.