Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update type definitions #2414

Merged
merged 1 commit into from
Feb 14, 2018
Merged

Update type definitions #2414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 37 additions & 1 deletion build/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ declare namespace dashjs {
on(type: AstInFutureEvent['type'], listener: (e: AstInFutureEvent) => void, scope?: object): void;
on(type: BufferEvent['type'], listener: (e: BufferEvent) => void, scope?: object): void;
on(type: ErrorEvent['type'], listener: (e: ErrorEvent) => void, scope?: object): void;
on(type: FragmentLoadingCompletedEvent['type'], listener: (e: FragmentLoadingCompletedEvent) => void, scope?: object): void;
on(type: FragmentLoadingAbandonedEvent['type'], listener: (e: FragmentLoadingAbandonedEvent) => void, scope?: object): void;
on(type: KeyErrorEvent['type'], listener: (e: KeyErrorEvent) => void, scope?: object): void;
on(type: KeyMessageEvent['type'], listener: (e: KeyMessageEvent) => void, scope?: object): void;
Expand All @@ -70,7 +71,7 @@ declare namespace dashjs {
on(type: StreamInitializedEvent['type'], listener: (e: StreamInitializedEvent) => void, scope?: object): void;
on(type: TextTracksAddedEvent['type'], listener: (e: TextTracksAddedEvent) => void, scope?: object): void;
on(type: string, listener: (e: Event) => void, scope?: object): void;
off(type: string, listener: (e: Event) => void, scope?: object): void;
off(type: string, listener: (e: any) => void, scope?: object): void;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e: Event causes compile compile errors when typescript's strictFunctionTypes compiler option is enabled. So unfortunately we must use e: any.

extend(parentNameString: string, childInstance: object, override: boolean): void;
attachView(element: HTMLElement): void;
attachSource(urlOrManifest: string | object): void;
Expand Down Expand Up @@ -128,6 +129,10 @@ declare namespace dashjs {
getUsePixelRatioInLimitBitrateByPortal(): any;
setUsePixelRatioInLimitBitrateByPortal(value: boolean): void;
setTextTrack(idx: number): void;
getTextDefaultLanguage(): string | undefined;
setTextDefaultLanguage(lang: string): void;
getTextDefaultEnabled(): boolean | undefined;
setTextDefaultEnabled(enable: boolean): void;
getThumbnail(time: number): Thumbnail;
getBitrateInfoListFor(type: 'video' | 'audio'): BitrateInfo[];
setInitialBitrateFor(type: 'video' | 'audio', value: number): void;
Expand Down Expand Up @@ -303,6 +308,13 @@ declare namespace dashjs {

export type ErrorEvent = GenericErrorEvent | DownloadErrorEvent | ManifestErrorEvent | TimedTextErrorEvent;

export interface FragmentLoadingCompletedEvent extends Event {
type: MediaPlayerEvents['FRAGMENT_LOADING_COMPLETED'];
request: FragmentRequest;
response: ArrayBuffer;
sender: object;
}

export interface FragmentLoadingAbandonedEvent extends Event {
type: MediaPlayerEvents['FRAGMENT_LOADING_ABANDONED'];
streamProcessor: object;
Expand Down Expand Up @@ -477,6 +489,30 @@ declare namespace dashjs {
qualityIndex: number;
}

export interface FragmentRequest {
action: string;
availabilityEndTime: number;
availabilityStartTime: Date;
bytesLoaded: number;
bytesTotal: number;
delayLoadingTime: number;
duration: number;
firstByteDate: Date;
index: number;
mediaInfo: MediaInfo;
mediaType: 'video' | 'audio' | 'text' | 'fragmentedText' | 'embeddedText';
quality: number;
representationId: string;
requestStartDate: Date;
requestEndDate: Date | null;
responseType: string;
serviceLocation: string;
startTime: number;
timescale: number;
type: 'InitializationSegment' | 'MediaSegment';
url: string;
}

export interface MediaSettings {
lang?: string;
viewpoint?: any;
Expand Down
38 changes: 37 additions & 1 deletion index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ declare namespace dashjs {
on(type: AstInFutureEvent['type'], listener: (e: AstInFutureEvent) => void, scope?: object): void;
on(type: BufferEvent['type'], listener: (e: BufferEvent) => void, scope?: object): void;
on(type: ErrorEvent['type'], listener: (e: ErrorEvent) => void, scope?: object): void;
on(type: FragmentLoadingCompletedEvent['type'], listener: (e: FragmentLoadingCompletedEvent) => void, scope?: object): void;
on(type: FragmentLoadingAbandonedEvent['type'], listener: (e: FragmentLoadingAbandonedEvent) => void, scope?: object): void;
on(type: KeyErrorEvent['type'], listener: (e: KeyErrorEvent) => void, scope?: object): void;
on(type: KeyMessageEvent['type'], listener: (e: KeyMessageEvent) => void, scope?: object): void;
Expand All @@ -70,7 +71,7 @@ declare namespace dashjs {
on(type: StreamInitializedEvent['type'], listener: (e: StreamInitializedEvent) => void, scope?: object): void;
on(type: TextTracksAddedEvent['type'], listener: (e: TextTracksAddedEvent) => void, scope?: object): void;
on(type: string, listener: (e: Event) => void, scope?: object): void;
off(type: string, listener: (e: Event) => void, scope?: object): void;
off(type: string, listener: (e: any) => void, scope?: object): void;
extend(parentNameString: string, childInstance: object, override: boolean): void;
attachView(element: HTMLElement): void;
attachSource(urlOrManifest: string | object): void;
Expand Down Expand Up @@ -128,6 +129,10 @@ declare namespace dashjs {
getUsePixelRatioInLimitBitrateByPortal(): any;
setUsePixelRatioInLimitBitrateByPortal(value: boolean): void;
setTextTrack(idx: number): void;
getTextDefaultLanguage(): string | undefined;
setTextDefaultLanguage(lang: string): void;
getTextDefaultEnabled(): boolean | undefined;
setTextDefaultEnabled(enable: boolean): void;
getThumbnail(time: number): Thumbnail;
getBitrateInfoListFor(type: 'video' | 'audio'): BitrateInfo[];
setInitialBitrateFor(type: 'video' | 'audio', value: number): void;
Expand Down Expand Up @@ -303,6 +308,13 @@ declare namespace dashjs {

export type ErrorEvent = GenericErrorEvent | DownloadErrorEvent | ManifestErrorEvent | TimedTextErrorEvent;

export interface FragmentLoadingCompletedEvent extends Event {
type: MediaPlayerEvents['FRAGMENT_LOADING_COMPLETED'];
request: FragmentRequest;
response: ArrayBuffer;
sender: object;
}

export interface FragmentLoadingAbandonedEvent extends Event {
type: MediaPlayerEvents['FRAGMENT_LOADING_ABANDONED'];
streamProcessor: object;
Expand Down Expand Up @@ -477,6 +489,30 @@ declare namespace dashjs {
qualityIndex: number;
}

export interface FragmentRequest {
action: string;
availabilityEndTime: number;
availabilityStartTime: Date;
bytesLoaded: number;
bytesTotal: number;
delayLoadingTime: number;
duration: number;
firstByteDate: Date;
index: number;
mediaInfo: MediaInfo;
mediaType: 'video' | 'audio' | 'text' | 'fragmentedText' | 'embeddedText';
quality: number;
representationId: string;
requestStartDate: Date;
requestEndDate: Date | null;
responseType: string;
serviceLocation: string;
startTime: number;
timescale: number;
type: 'InitializationSegment' | 'MediaSegment';
url: string;
}

export interface MediaSettings {
lang?: string;
viewpoint?: any;
Expand Down