@movingimage-evp/player-sdk
    Preparing search index...

    Interface PlayerInstance

    Describes the public instance surface of the Player class.

    This is used as the this type for EventCallback, so callbacks can be typed without creating a dependency on the Player class itself.

    interface PlayerInstance {
        addCuePoint(cuepoint: CuePoint): Promise<string>;
        autoplay(mode?: AutoplayMode): Promise<void>;
        destroy(): Promise<void>;
        getChannelId(): string | undefined;
        getCuePoints(): Promise<CuePoint[]>;
        getCurrentTime(): Promise<number>;
        getDuration(): Promise<number>;
        getPlayerId(): string;
        getVideoAspectRatio(): Promise<string | null>;
        getVideoId(): string;
        getVolume(): Promise<number>;
        isMuted(): Promise<boolean>;
        mute(): Promise<void>;
        off<K extends PlayerEventNames>(
            eventName: K,
            callback?: EventCallback<PlayerEvents[K]>,
        ): void;
        on<K extends PlayerEventNames>(
            eventName: K,
            callback: EventCallback<PlayerEvents[K]>,
        ): void;
        pause(): Promise<void>;
        play(): Promise<void>;
        removeCuePoint(id: string): Promise<void>;
        setAnalytics(mode: AnalyticsMode): Promise<void>;
        setColors(colors: ColorSettings): Promise<void>;
        setCurrentTime(time: number): Promise<void>;
        setLanguage(language: string): Promise<void>;
        setNoUI(noUI: boolean): Promise<void>;
        setVolume(volume: number): Promise<void>;
        unmute(): Promise<void>;
    }

    Implemented by

    Index
    • Parameters

      Returns Promise<string>

    • Returns Promise<void>

    • Returns string | undefined

    • Returns Promise<number>

    • Returns Promise<number>

    • Returns string

    • Returns Promise<string | null>

    • Returns string

    • Returns Promise<number>

    • Returns Promise<boolean>

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • id: string

      Returns Promise<void>

    • Parameters

      • time: number

      Returns Promise<void>

    • Parameters

      • language: string

      Returns Promise<void>

    • Parameters

      • noUI: boolean

      Returns Promise<void>

    • Parameters

      • volume: number

      Returns Promise<void>

    • Returns Promise<void>