Class CourseraHelper

Shared class for all videojs players

Hierarchy (View Summary)

VideoHelper.VideoJSHelper.VideoJSHelper
- CourseraHelper

Index

Constructors

Properties

API_ORIGIN extraInfo fetch language origin referer service? SUBTITLE_FORMAT SUBTITLE_SOURCE video?

Methods

getCourseData getCourseId getCourseSlug getSubtitles getVideoData getVideoDataByPlayer getVideoId returnBaseData getPlayer

Constructors

constructor

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

Properties

API_ORIGIN

API_ORIGIN: string = "https://www.coursera.org/api"

extraInfo

extraInfo: boolean

fetch

fetch: FetchFunction

language

language: string

origin

origin: string

referer

referer: string

`Optional`service

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

SUBTITLE_FORMAT

SUBTITLE_FORMAT: "vtt" | "srt" | "json" = "vtt"

SUBTITLE_SOURCE

SUBTITLE_SOURCE: string = "coursera"

`Optional`video

video?: HTMLVideoElement

Methods

getCourseData

getCourseData(courseIdOrSlug: string | number): Promise<Course | undefined>
Parameters
- courseIdOrSlug: string | number
Returns Promise<Course | undefined>
- Defined in packages/ext/src/helpers/coursera.ts:16

getCourseId

getCourseId(): string | undefined
Returns string | undefined
- Defined in packages/ext/src/helpers/coursera.ts:43

getCourseSlug

getCourseSlug(): string | undefined
Returns string | undefined
- Defined in packages/ext/src/helpers/coursera.ts:36

getSubtitles

getSubtitles(): VideoDataSubtitle[]
Returns VideoDataSubtitle[]
Inherited from VideoJSHelper.getSubtitles
- Defined in packages/ext/src/players/videojs.ts:139

getVideoData

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

getVideoDataByPlayer

getVideoDataByPlayer(
    videoId: string,
):
    | {
        duration: number
        | undefined;
        subtitles: VideoDataSubtitle[];
        url: string;
    }
    | undefined
Parameters
- videoId: string
Returns
    | {
        duration: number
        | undefined;
        subtitles: VideoDataSubtitle[];
        url: string;
    }
    | undefined
Inherited from VideoJSHelper.getVideoDataByPlayer
- Defined in packages/ext/src/players/videojs.ts:80

getVideoId

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

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 VideoJSHelper.returnBaseData
- Defined in packages/ext/src/helpers/base.ts:56

`Static`getPlayer

getPlayer<
T extends
VOTTypes.VideoJSType.PlayerOptions = VOTTypes.CourseraType.PlayerOptions,
>(): VOTTypes.VideoJSType.Player<T>
| undefined
Type Parameters
- T extends VOTTypes.VideoJSType.PlayerOptions = VOTTypes.CourseraType.PlayerOptions
Returns VOTTypes.VideoJSType.Player<T> | undefined
Overrides VideoJSHelper.getPlayer
- Defined in packages/ext/src/helpers/coursera.ts:62