twitch-player/build/main/lib/everything/TwitchEmbed.d.ts

A Typescript wrapper for the Twitch embeddable, interactive media player.

import { TwitchEmbedOptions } from './TwitchEmbedOptions';
import { PlaybackStatistics } from './model/PlaybackStatistics';
import { Quality } from './model/Quality';
import { TwitchPlayer } from './video/TwitchPlayer';
import { TwitchPlayerEvent } from './video/TwitchPlayerEvent';
/**
 * A TS wrapper for the Twitch interactive media player, that can also include the chat.
 */
export declare class TwitchEmbed {
    /**
     * The div HTML element where the player will appear.
     */
    get divId(): string;
    /**
     * The player options that were provided when the instance was constructed.
     */
    get twitchEmbedOptions(): TwitchEmbedOptions;
    private readonly _embed;
    private readonly _divId;
    private readonly _player;
    private readonly _twitchEmbedOptions;
    /**
     * Creates a new TwitchEmbed instance.
     * @param divId The div HTML element where the player will appear.
     * @param options The player initialization options.
     */
    constructor(divId: string, options: TwitchEmbedOptions);
    /**
     * Adds an event listener for the given event.
     * @param event The event type to which the listener should react.
     * @param callback The logic that should happen when the listener fires.
     */
    addEventListener(event: TwitchPlayerEvent, callback: () => void): void;
    /**
     * Disables the captions for the content that is currently playing.
     * @deprecated Use with caution, not inculded in the official Twitch documentation.
     */
    disableCaptions(): void;
    /**
     * Enables the captions for the content that is currently playing.
     * @deprecated Use with caution, not inculded in the official Twitch documentation.
     */
    enableCaptions(): void;
    /**
     * Retrieves the playback statistics for this player.
     * The statistics contain information such as video FPS, resolution, latency and dropped frames.
     * @deprecated Use with caution, not inculded in the official Twitch documentation.
     */
    getPlaybackStatistics(): PlaybackStatistics;
    /**
     * Returns the channel’s identifier. Works only for live streams, not VODs.
     */
    getChannelId(): string | undefined;
    /**
     * Returns the name of the collection currently being played.
     */
    getCollection(): string | undefined;
    /**
     * Sets the channel to be played.
     * @param channelId The selected channel's identifier.
     */
    setChannelId(channelId: string): void;
    /**
     * Returns the Twitch.Player object.
     * Can be used for more fine-grained control of the player.
     */
    getPlayer(): TwitchPlayer;
    /**
     * Pauses the player.
     */
    pause(): void;
    /**
     * Begins playing the specified video.
     */
    play(): void;
    /**
     * Seeks to the specified timestamp (in seconds) in the video and resumes playing if paused. Does not work for live streams.
     * @param timestamp The specified timestamp (in seconds).
     */
    seek(timestamp: number): void;
    /**
     * Sets the channel to be played.
     * @param channel The selected channel.
     */
    setChannel(channel: string): void;
    /**
     * Sets the collection to be played.
     * Optionally also specifies the video within the collection, from which to start playback.
     * If a video ID is not provided here or the specified video is not part of the collection,
     * playback starts with the first video in the collection.
     * @param collectionId The identifier for the collection.
     * @param videoId The identifier for the video.
     */
    setCollection(collectionId: string, videoId?: string): void;
    /**
     * Sets the quality of the video. quality should be a string value returned by getQualities.
     * @param quality The quality to be set.
     */
    setQuality(quality: string): void;
    /**
     * Sets the video to be played to be played and starts playback at timestamp (in seconds).
     * @param videoID The identifier of the video to be played.
     * @param timestamp The spot where the playback will be started (in seconds).
     */
    setVideo(videoID: string, timestamp: number): void;
    /**
     * Returns true if the player is muted; otherwise, false.
     */
    getMuted(): boolean;
    /**
     * If true, mutes the player; otherwise, unmutes it. This is independent of the volume setting.
     * @param muted If true, player will be muted. Otherwise, it will be unmuted.
     */
    setMuted(muted: boolean): void;
    /**
     * Returns the volume level, a value between 0.0 and 1.0.
     */
    getVolume(): number;
    /**
     * Sets the volume to the specified volume level, a value between 0.0 and 1.0.
     * @param volumeLevel A number between 0 and 1.
     */
    setVolume(volumeLevel: number): void;
    /**
     * Returns the channel’s name. Works only for live streams, not VODs.
     */
    getChannel(): string | undefined;
    /**
     * Returns the current video’s timestamp, in seconds. Works only for VODs, not live streams.
     */
    getCurrentTime(): number;
    /**
     * Returns the duration of the video, in seconds. Works only for VODs,not live streams.
     */
    getDuration(): number;
    /**
     * Returns true if the live stream or VOD has ended; otherwise, false.
     */
    getEnded(): boolean;
    /**
     * Returns the available video qualities. For example, chunked (pass-through of the original source).
     */
    getQualities(): Quality[];
    /**
     * Returns the current quality of video playback.
     */
    getQuality(): string;
    /**
     * Returns the video ID. Works only for VODs, not live streams.
     */
    getVideo(): string | undefined;
    /**
     * Returns true if the video is paused; otherwise, false. Buffering or seeking is considered playing.
     */
    isPaused(): boolean;
}