Class TwitchHelper

Hierarchy (View Summary)

BaseHelper
- TwitchHelper

Index

Constructors

constructor

new TwitchHelper(
__namedParameters?: VOTTypes.BaseHelper.BaseHelperOpts,
): VideoHelper.TwitchHelper.TwitchHelper
Parameters
- __namedParameters: VOTTypes.BaseHelper.BaseHelperOpts = {}
Returns VideoHelper.TwitchHelper.TwitchHelper
Inherited from BaseHelper.constructor
- Defined in packages/ext/src/helpers/base.ts:28

Properties

API_ORIGIN

API_ORIGIN: string = "https://clips.twitch.tv"

extraInfo

extraInfo: boolean

fetch

fetch: FetchFunction

language

language: string

origin

origin: string

referer

referer: string

`Optional`service

service?: VOTTypes.ServiceType.ServiceConf<VOTTypes.ServiceType.VideoService>

`Optional`video

video?: HTMLVideoElement

Methods

getClipLink

getClipLink(
pathname: string,
clipId: string | null,
): Promise<string | undefined>
Parameters
- pathname: string
- clipId: string | null
Returns Promise<string | undefined>
- Defined in packages/ext/src/helpers/twitch.ts:9

getVideoData

getVideoData(
videoId: string,
): Promise<VOTTypes.ClientType.MinimalVideoData | undefined>
Parameters
- videoId: string
Returns Promise<VOTTypes.ClientType.MinimalVideoData | undefined>
Overrides BaseHelper.getVideoData
- Defined in packages/ext/src/helpers/twitch.ts:42

getVideoId

getVideoId(url: URL): Promise<string | undefined>
Parameters
- url: URL
Returns Promise<string | undefined>
Overrides BaseHelper.getVideoId
- Defined in packages/ext/src/helpers/twitch.ts:57

returnBaseData

returnBaseData(
    videoId: string,
):
    | {
        duration: undefined;
        host: VOTTypes.ServiceType.VideoService;
        url: string;
        videoId: string;
    }
    | undefined
Parameters
- videoId: string
Returns
    | {
        duration: undefined;
        host: VOTTypes.ServiceType.VideoService;
        url: string;
        videoId: string;
    }
    | undefined
Inherited from BaseHelper.returnBaseData
- Defined in packages/ext/src/helpers/base.ts:56

Class TwitchHelper

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideoHelper.TwitchHelper.TwitchHelper

Properties

API_ORIGIN

extraInfo

fetch

language

origin

referer

`Optional`service

`Optional`video

Methods

getClipLink

Parameters

Returns Promise<string | undefined>

getVideoData

Parameters

Returns Promise<VOTTypes.ClientType.MinimalVideoData | undefined>

getVideoId

Parameters

Returns Promise<string | undefined>

returnBaseData

Parameters

Returns
    | {
        duration: undefined;
        host: VOTTypes.ServiceType.VideoService;
        url: string;
        videoId: string;
    }
    | undefined

Settings

On This Page

Class TwitchHelper

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideoHelper.TwitchHelper.TwitchHelper

Properties

API_ORIGIN

extraInfo

fetch

language

origin

referer

Optionalservice

Optionalvideo

Methods

getClipLink

Parameters

Returns Promise<string | undefined>

getVideoData

Parameters

Returns Promise<VOTTypes.ClientType.MinimalVideoData | undefined>

getVideoId

Parameters

Returns Promise<string | undefined>

returnBaseData

Parameters

Returns | { duration: undefined; host: VOTTypes.ServiceType.VideoService; url: string; videoId: string; } | undefined

Settings

On This Page

`Optional`service

`Optional`video

Returns
| {
duration: undefined;
host: VOTTypes.ServiceType.VideoService;
url: string;
videoId: string;
}
| undefined