From b3a3a0746c9fde9e6119e8a777e9857a6b2e1df2 Mon Sep 17 00:00:00 2001 From: Tobias Lundin Date: Wed, 10 Jun 2015 15:14:12 +0200 Subject: [PATCH 1/3] chrome: Add queue-interface for cast --- chrome/{chrome-cast.ts => chrome-cast.d.ts} | 253 ++++++++++++++++++-- 1 file changed, 238 insertions(+), 15 deletions(-) rename chrome/{chrome-cast.ts => chrome-cast.d.ts} (79%) diff --git a/chrome/chrome-cast.ts b/chrome/chrome-cast.d.ts similarity index 79% rename from chrome/chrome-cast.ts rename to chrome/chrome-cast.d.ts index 71a530542..a314fb063 100644 --- a/chrome/chrome-cast.ts +++ b/chrome/chrome-cast.d.ts @@ -206,7 +206,7 @@ declare module chrome.cast { sessionListener: (session: chrome.cast.Session) => void, receiverListener: (receiverAvailability: chrome.cast.ReceiverAvailability) => void, autoJoinPolicy?: chrome.cast.AutoJoinPolicy, - defaultActionPolicy: chrome.cast.DefaultActionPolicy + defaultActionPolicy?: chrome.cast.DefaultActionPolicy ); sessionRequest: chrome.cast.SessionRequest; @@ -419,6 +419,17 @@ declare module chrome.cast { successCallback: (media: chrome.cast.media.Media) => void, errorCallback: (error: chrome.cast.Error) => void ) + + /** + * @param {!chrome.cast.media.QueueLoadRequest} queueLoadRequest + * @param {function(!chrome.cast.media.Media)} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueLoad( + queueLoadRequest: chrome.cast.media.QueueLoadRequest, + successCallback: (media: chrome.cast.media.Media) => void, + errorCallback: (error: chrome.cast.Error) => void + ) } interface Receiver { @@ -479,6 +490,9 @@ declare module chrome.cast { } declare module chrome.cast.media { + + const DEFAULT_MEDIA_RECEIVER_APP_ID: string; + /** * @enum {string} * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.MediaCommand @@ -542,7 +556,98 @@ declare module chrome.cast.media { FINISHED: string; ERROR: string; } - + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest + */ + interface RepeatMode { + OFF:string; + ALL:string; + SINGLE:string; + ALL_AND_SHUFFLE:string; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueItem + */ + interface QueueItem { + new( + mediaInfo: chrome.cast.media.MediaInfo + ); + + activeTrackIds: Array; + autoplay: boolean; + customData: Object; + itemId: number; + media: chrome.cast.media.MediaInfo; + preloadTime: number; + startTime: number; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest + */ + interface QueueLoadRequest { + new( + items: Array + ); + + customData: Object; + items: Array; + repeatMode: chrome.cast.media.RepeatMode; + startIndex: number; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueInsertItemsRequest + */ + interface QueueInsertItemsRequest { + new( + itemsToInsert: Array + ); + + customData: Object; + insertBefore:number; + items: Array; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueRemoveItemsRequest + */ + interface QueueRemoveItemsRequest { + new( + itemIdsToRemove: Array + ); + + customData: Object; + itemIds: Array; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueReorderItemsRequest + */ + interface QueueReorderItemsRequest { + new( + itemIdsToReorder: Array + ); + + customData: Object; + insertBefore: number; + itemIds: Array; + } + + /** + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueUpdateItemsRequest + */ + interface QueueUpdateItemsRequest { + new( + itemsToUpdate: Array + ); + + customData: Object; + item: Array; + } + /** * @enum {string} * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.TrackType @@ -724,7 +829,7 @@ declare module chrome.cast.media { images: Array; releaseDate: string; - // Deprecated + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; releaseYear: number; } @@ -743,7 +848,7 @@ declare module chrome.cast.media { images: Array; releaseDate: string; - // Deprecated + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; releaseYear: number; } @@ -763,7 +868,7 @@ declare module chrome.cast.media { images: Array; originalAirdate: string; - // Deprecated + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; episodeTitle: string; seasonNumber: number; @@ -790,7 +895,7 @@ declare module chrome.cast.media { images: Array; releaseDate: string; - // Deprecated + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; artistName: string; releaseYear: number; @@ -814,7 +919,7 @@ declare module chrome.cast.media { height: number; creationDateTime: string; - // Deprecated + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; } @@ -852,18 +957,23 @@ declare module chrome.cast.media { mediaSessionId: number ); - sessionId: string; - mediaSessionId: number; + activeTrackIds: Array; + currentItemId: number; + customData: Object; + idleReason: chrome.cast.media.IdleReason; + items: Array; + loadingItemId: number; media: chrome.cast.media.MediaInfo; + mediaSessionId: number; playbackRate: number; playerState: chrome.cast.media.PlayerState; + preloadedItemId: number; + repeatMode: chrome.cast.media.RepeatMode; + sessionId: string; supportedMediaCommands: Array; volume: chrome.cast.Volume; - idleReason: chrome.cast.media.IdleReason; - activeTrackIds: Array; - customData: Object; - - // Deprecated + + /** Deprecated. Use getEstimatedTime instead */ currentTime: number; /** @@ -965,12 +1075,120 @@ declare module chrome.cast.media { listener: (boolean) => void ) - // Deprecated /** * @return {number} * @suppress {deprecated} Uses currentTime member to compute estimated time. */ getEstimatedTime(): number + + /** + * @param {!chrome.cast.media.QueueItem} item + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueAppendItem ( + item: chrome.cast.media.QueueItem, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!chrome.cast.media.QueueInsertItemsRequest} queueInsertItemsRequest + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueInsertItems ( + queueInsertItemsRequest: chrome.cast.media.QueueInsertItemsRequest, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!number} itemId + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueJumpToItem ( + itemId: number, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!number} itemId + * @param {!number} newIndex + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueMoveItemToNewIndex ( + itemId: number, + newIndex: number, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueNext ( + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queuePrev ( + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!number} itemId + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueRemoveItem ( + itemId: number, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!chrome.cast.media.QueueReorderItemsRequest} queueReorderItemsRequest + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueReorderItems ( + queueReorderItemsRequest: chrome.cast.media.QueueReorderItemsRequest, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!chrome.cast.media.RepeatMode} repeatMode + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueSetRepeatMode ( + repeatMode: chrome.cast.media.RepeatMode, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + + /** + * @param {!chrome.cast.media.QueueUpdateItemsRequest} queueUpdateItemsRequest + * @param {function()} successCallback + * @param {function(!chrome.cast.Error)} errorCallback + */ + queueUpdateItems ( + queueUpdateItemsRequest: chrome.cast.media.QueueUpdateItemsRequest, + successCallback: Function, + errorCallback: (error: chrome.cast.Error) => void + ) + } interface Track { @@ -1030,4 +1248,9 @@ declare module chrome.cast.media.timeout { var stop: number; var setVolume: number; var editTracksInfo: number; + var queueInsert: number; + var queueLoad: number; + var queueRemove: number; + var queueReorder: number; + var queueUpdate: number; } \ No newline at end of file From 2a714679f74a80b935ed3d968815506fa08fba7e Mon Sep 17 00:00:00 2001 From: Tobias Lundin Date: Thu, 11 Jun 2015 09:45:01 +0200 Subject: [PATCH 2/3] chrome: fix failing tests for cast syntax --- chrome/chrome-cast.d.ts | 150 ++++++++++++++++++++-------------------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/chrome/chrome-cast.d.ts b/chrome/chrome-cast.d.ts index a314fb063..53945029f 100644 --- a/chrome/chrome-cast.d.ts +++ b/chrome/chrome-cast.d.ts @@ -188,7 +188,7 @@ declare module chrome.cast { receiver: chrome.cast.Receiver, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void interface ApiConfig { /** @@ -207,7 +207,7 @@ declare module chrome.cast { receiverListener: (receiverAvailability: chrome.cast.ReceiverAvailability) => void, autoJoinPolicy?: chrome.cast.AutoJoinPolicy, defaultActionPolicy?: chrome.cast.DefaultActionPolicy - ); + ):ApiConfig; sessionRequest: chrome.cast.SessionRequest; sessionListener: (session: chrome.cast.Session) => void; @@ -228,7 +228,7 @@ declare module chrome.cast { code: chrome.cast.ErrorCode, description?: string, details?: Object - ); + ):Error; code: chrome.cast.ErrorCode; description?: string; @@ -244,7 +244,7 @@ declare module chrome.cast { */ new( url: string - ); + ):Image; url: string; height?: number; @@ -255,7 +255,7 @@ declare module chrome.cast { new( platform: chrome.cast.SenderPlatform - ); + ):SenderApplication; platform: chrome.cast.SenderPlatform; url?: string; @@ -274,7 +274,7 @@ declare module chrome.cast { appId: string, capabilities?: Array, timeout?: number - ); + ):SessionRequest; appId: string; capabilities: Array; @@ -298,7 +298,7 @@ declare module chrome.cast { displayName: string, appImages: Array, receiver: chrome.cast.Receiver - ); + ):Session; sessionId: string; appId: string; @@ -319,7 +319,7 @@ declare module chrome.cast { newLevel: number, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {boolean} muted @@ -330,7 +330,7 @@ declare module chrome.cast { muted: boolean, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {function()} successCallback @@ -339,7 +339,7 @@ declare module chrome.cast { leave( successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {function()} successCallback @@ -348,7 +348,7 @@ declare module chrome.cast { stop( successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {string} namespace @@ -361,21 +361,21 @@ declare module chrome.cast { message: string, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {function(boolean)} listener */ addUpdateListener( - listener: (boolean) => void - ) + listener: (isAlive:boolean) => void + ):void /** * @param {function(boolean)} listener */ removeUpdateListener( - listener: (boolean) => void - ) + listener: (isAlive:boolean) => void + ):void /** * @param {string} namespace @@ -383,8 +383,8 @@ declare module chrome.cast { */ addMessageListener( namespace: string, - listener: (string, string) => void - ) + listener: (namespace: string, message: string) => void + ):void /** * @param {string} namespace @@ -392,22 +392,22 @@ declare module chrome.cast { */ removeMessageListener( namespace: string, - listener: (string, string) => void - ) + listener: (namespace:string, message:string) => void + ):void /** * @param {function(!chrome.cast.media.Media)} listener */ addMediaListener( listener: (media: chrome.cast.media.Media) => void - ) + ):void /** * @param {function(!chrome.cast.media.Media)} listener */ removeMediaListener( listener: (media: chrome.cast.media.Media) => void - ) + ):void /** * @param {!chrome.cast.media.LoadRequest} loadRequest @@ -418,7 +418,7 @@ declare module chrome.cast { loadRequest: chrome.cast.media.LoadRequest, successCallback: (media: chrome.cast.media.Media) => void, errorCallback: (error: chrome.cast.Error) => void - ) + ):void /** * @param {!chrome.cast.media.QueueLoadRequest} queueLoadRequest @@ -429,7 +429,7 @@ declare module chrome.cast { queueLoadRequest: chrome.cast.media.QueueLoadRequest, successCallback: (media: chrome.cast.media.Media) => void, errorCallback: (error: chrome.cast.Error) => void - ) + ):void } interface Receiver { @@ -446,7 +446,7 @@ declare module chrome.cast { friendlyName: string, capabilities?: Array, volume?: chrome.cast.Volume - ); + ):Receiver; label: string; friendlyName: string; @@ -466,7 +466,7 @@ declare module chrome.cast { new( statusText: string, appImages: Array - ); + ):ReceiverDisplayStatus; statusText: string; appImages: Array; @@ -482,7 +482,7 @@ declare module chrome.cast { new( level?: number, muted?: boolean - ); + ):Volume; level?: number; muted?: boolean; @@ -491,7 +491,7 @@ declare module chrome.cast { declare module chrome.cast.media { - const DEFAULT_MEDIA_RECEIVER_APP_ID: string; + var DEFAULT_MEDIA_RECEIVER_APP_ID: string; /** * @enum {string} @@ -573,7 +573,7 @@ declare module chrome.cast.media { interface QueueItem { new( mediaInfo: chrome.cast.media.MediaInfo - ); + ):QueueItem; activeTrackIds: Array; autoplay: boolean; @@ -590,7 +590,7 @@ declare module chrome.cast.media { interface QueueLoadRequest { new( items: Array - ); + ):QueueLoadRequest; customData: Object; items: Array; @@ -604,7 +604,7 @@ declare module chrome.cast.media { interface QueueInsertItemsRequest { new( itemsToInsert: Array - ); + ):QueueInsertItemsRequest; customData: Object; insertBefore:number; @@ -617,7 +617,7 @@ declare module chrome.cast.media { interface QueueRemoveItemsRequest { new( itemIdsToRemove: Array - ); + ):QueueRemoveItemsRequest; customData: Object; itemIds: Array; @@ -629,7 +629,7 @@ declare module chrome.cast.media { interface QueueReorderItemsRequest { new( itemIdsToReorder: Array - ); + ):QueueReorderItemsRequest; customData: Object; insertBefore: number; @@ -642,7 +642,7 @@ declare module chrome.cast.media { interface QueueUpdateItemsRequest { new( itemsToUpdate: Array - ); + ):QueueUpdateItemsRequest; customData: Object; item: Array; @@ -722,7 +722,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.GetStatusRequest */ - new(); + new():GetStatusRequest; customData: Object; } @@ -732,7 +732,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.PauseRequest */ - new(); + new():PauseRequest; customData: Object; } @@ -742,7 +742,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.PlayRequest */ - new(); + new():PlayRequest; customData: Object; } @@ -752,7 +752,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.SeekRequest */ - new(); + new():SeekRequest; currentTime: number; resumeState: chrome.cast.media.ResumeState; @@ -764,7 +764,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.StopRequest */ - new(); + new():StopRequest; customData: Object; } @@ -777,7 +777,7 @@ declare module chrome.cast.media { */ new( volume: chrome.cast.Volume - ); + ):VolumeRequest; volume: chrome.cast.Volume; customData: Object; @@ -791,7 +791,7 @@ declare module chrome.cast.media { */ new( mediaInfo: chrome.cast.media.MediaInfo - ); + ):LoadRequest; activeTrackIds: Array; autoplay: boolean; @@ -810,7 +810,7 @@ declare module chrome.cast.media { new( activeTrackIds?: Array, textTrackStyle?: chrome.cast.media.TextTrackStyle - ); + ):EditTracksInfoRequest; activeTrackIds: Array; textTrackStyle: chrome.cast.media.TextTrackStyle; @@ -821,17 +821,17 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.GenericMediaMetadata */ - new(); + new():GenericMediaMetadata; - metadataType: chrome.cast.media.MetadataType; - title: string; - subtitle: string; images: Array; + metadataType: chrome.cast.media.MetadataType; releaseDate: string; + releaseYear: number; + subtitle: string; + title: string; /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; - releaseYear: number; } interface MovieMediaMetadata { @@ -839,18 +839,18 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.MovieMediaMetadata */ - new(); - + new():MovieMediaMetadata; + + images: Array; metadataType: chrome.cast.media.MetadataType; + releaseDate: string; + releaseYear: number; + subtitle: string; title: string; studio: string; - subtitle: string; - images: Array; - releaseDate: string; - + /** Deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; - releaseYear: number; } interface TvShowMediaMetadata { @@ -858,7 +858,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.TvShowMediaMetadata */ - new(); + new(): TvShowMediaMetadata; metadataType: chrome.cast.media.MetadataType; seriesTitle: string; @@ -881,7 +881,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.MusicTrackMediaMetadata */ - new(); + new(): MusicTrackMediaMetadata; metadataType: chrome.cast.media.MetadataType; albumName: string; @@ -906,7 +906,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.PhotoMediaMetadata */ - new(); + new(): PhotoMediaMetadata; metadataType: chrome.cast.media.MetadataType; title: string; @@ -933,7 +933,7 @@ declare module chrome.cast.media { new( contentId: string, contentType: string - ); + ): MediaInfo; contentId: string; streamType: chrome.cast.media.StreamType; @@ -955,7 +955,7 @@ declare module chrome.cast.media { new( sessionId: string, mediaSessionId: number - ); + ): Media; activeTrackIds: Array; currentItemId: number; @@ -1065,15 +1065,15 @@ declare module chrome.cast.media { * @param {function(boolean)} listener */ addUpdateListener( - listener: (boolean) => void - ) + listener: (isAlive:boolean) => void + ): void /** * @param {function(boolean)} listener */ removeUpdateListener( - listener: (boolean) => void - ) + listener: (isAlive:boolean) => void + ): void /** * @return {number} @@ -1090,7 +1090,7 @@ declare module chrome.cast.media { item: chrome.cast.media.QueueItem, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!chrome.cast.media.QueueInsertItemsRequest} queueInsertItemsRequest @@ -1101,7 +1101,7 @@ declare module chrome.cast.media { queueInsertItemsRequest: chrome.cast.media.QueueInsertItemsRequest, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!number} itemId @@ -1112,7 +1112,7 @@ declare module chrome.cast.media { itemId: number, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!number} itemId @@ -1125,7 +1125,7 @@ declare module chrome.cast.media { newIndex: number, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {function()} successCallback @@ -1134,7 +1134,7 @@ declare module chrome.cast.media { queueNext ( successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {function()} successCallback @@ -1143,7 +1143,7 @@ declare module chrome.cast.media { queuePrev ( successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!number} itemId @@ -1154,7 +1154,7 @@ declare module chrome.cast.media { itemId: number, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!chrome.cast.media.QueueReorderItemsRequest} queueReorderItemsRequest @@ -1165,7 +1165,7 @@ declare module chrome.cast.media { queueReorderItemsRequest: chrome.cast.media.QueueReorderItemsRequest, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!chrome.cast.media.RepeatMode} repeatMode @@ -1176,7 +1176,7 @@ declare module chrome.cast.media { repeatMode: chrome.cast.media.RepeatMode, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void /** * @param {!chrome.cast.media.QueueUpdateItemsRequest} queueUpdateItemsRequest @@ -1187,7 +1187,7 @@ declare module chrome.cast.media { queueUpdateItemsRequest: chrome.cast.media.QueueUpdateItemsRequest, successCallback: Function, errorCallback: (error: chrome.cast.Error) => void - ) + ): void } @@ -1201,7 +1201,7 @@ declare module chrome.cast.media { new( trackId: number, trackType: chrome.cast.media.TrackType - ); + ): Track; trackId: number; trackContentId: string; @@ -1218,7 +1218,7 @@ declare module chrome.cast.media { * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.TextTrackStyle */ - new(); + new(): TextTrackStyle; foregroundColor: string; backgroundColor: string; From 83a7215480b4d02ca8f4f93bd84ba2cb9e7a2d5a Mon Sep 17 00:00:00 2001 From: Tobias Lundin Date: Wed, 17 Jun 2015 14:12:36 +0200 Subject: [PATCH 3/3] chrome: use @deprecated where appropiate and add documentation strings --- chrome/chrome-cast.d.ts | 112 ++++++++++++++++++++++++---------------- 1 file changed, 68 insertions(+), 44 deletions(-) diff --git a/chrome/chrome-cast.d.ts b/chrome/chrome-cast.d.ts index 53945029f..71a60ff10 100644 --- a/chrome/chrome-cast.d.ts +++ b/chrome/chrome-cast.d.ts @@ -106,13 +106,14 @@ declare module chrome.cast { } /** - * @const {!Array.} - * @see https://developers.google.com/cast/docs/reference/chrome/ + * @const {!Array} + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast#.VERSION */ var VERSION: Array; /** * @type {boolean} + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast#.isAvailable */ var isAvailable: boolean; @@ -169,7 +170,7 @@ declare module chrome.cast { ): void /** - * @param {!Array.} receivers + * @param {!Array} receivers * @param {function()} successCallback * @param {function(chrome.cast.Error)} errorCallback */ @@ -194,7 +195,7 @@ declare module chrome.cast { /** * @param {!chrome.cast.SessionRequest} sessionRequest * @param {function(!chrome.cast.Session)} sessionListener - * @param {function(!chrome.cast.ReceiverAvailability,Array.)} + * @param {function(!chrome.cast.ReceiverAvailability,Array)} * receiverListener * @param {chrome.cast.AutoJoinPolicy=} opt_autoJoinPolicy * @param {chrome.cast.DefaultActionPolicy=} opt_defaultActionPolicy @@ -216,14 +217,14 @@ declare module chrome.cast { defaultActionPolicy: chrome.cast.DefaultActionPolicy; } - /** - * @param {!chrome.cast.ErrorCode} code - * @param {string=} opt_description - * @param {Object=} opt_details - * @constructor - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Error - */ interface Error { + /** + * @param {!chrome.cast.ErrorCode} code + * @param {string=} opt_description + * @param {Object=} opt_details + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Error + */ new( code: chrome.cast.ErrorCode, description?: string, @@ -252,7 +253,11 @@ declare module chrome.cast { } interface SenderApplication { - + /** + * @param {!chrome.cast.SenderPlatform} platform + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.SenderApplication + */ new( platform: chrome.cast.SenderPlatform ):SenderApplication; @@ -265,7 +270,7 @@ declare module chrome.cast { interface SessionRequest { /** * @param {string} appId - * @param {!Array.=} opt_capabilities + * @param {!Array=} opt_capabilities * @param {number=} opt_timeout * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.SessionRequest @@ -287,7 +292,7 @@ declare module chrome.cast { * @param {string} sessionId * @param {string} appId * @param {string} displayName - * @param {!Array.} appImages + * @param {!Array} appImages * @param {!chrome.cast.Receiver} receiver * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Session @@ -436,7 +441,7 @@ declare module chrome.cast { /** * @param {string} label * @param {string} friendlyName - * @param {Array.=} opt_capabilities + * @param {Array=} opt_capabilities * @param {chrome.cast.Volume=} opt_volume * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Receiver @@ -459,7 +464,7 @@ declare module chrome.cast { interface ReceiverDisplayStatus { /** * @param {string} statusText - * @param {!Array.} appImages + * @param {!Array} appImages * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.ReceiverDisplayStatus */ @@ -558,7 +563,8 @@ declare module chrome.cast.media { } /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest + * @enum {string} + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media#.RepeatMode */ interface RepeatMode { OFF:string; @@ -567,10 +573,12 @@ declare module chrome.cast.media { ALL_AND_SHUFFLE:string; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueItem - */ interface QueueItem { + /** + * @param {!chrome.cast.media.MediaInfo} mediaInfo + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueItem + */ new( mediaInfo: chrome.cast.media.MediaInfo ):QueueItem; @@ -584,10 +592,12 @@ declare module chrome.cast.media { startTime: number; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest - */ interface QueueLoadRequest { + /** + * @param {!Array} items + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest + */ new( items: Array ):QueueLoadRequest; @@ -598,10 +608,12 @@ declare module chrome.cast.media { startIndex: number; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueInsertItemsRequest - */ interface QueueInsertItemsRequest { + /** + * @param {!Array} + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueInsertItemsRequest + */ new( itemsToInsert: Array ):QueueInsertItemsRequest; @@ -611,10 +623,12 @@ declare module chrome.cast.media { items: Array; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueRemoveItemsRequest - */ interface QueueRemoveItemsRequest { + /** + * @param {!Array} + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueRemoveItemsRequest + */ new( itemIdsToRemove: Array ):QueueRemoveItemsRequest; @@ -623,10 +637,12 @@ declare module chrome.cast.media { itemIds: Array; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueReorderItemsRequest - */ interface QueueReorderItemsRequest { + /** + * @param {!Array} + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueReorderItemsRequest + */ new( itemIdsToReorder: Array ):QueueReorderItemsRequest; @@ -636,10 +652,12 @@ declare module chrome.cast.media { itemIds: Array; } - /** - * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueUpdateItemsRequest - */ interface QueueUpdateItemsRequest { + /** + * @param {!Array} + * @constructor + * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueUpdateItemsRequest + */ new( itemsToUpdate: Array ):QueueUpdateItemsRequest; @@ -802,7 +820,7 @@ declare module chrome.cast.media { interface EditTracksInfoRequest { /** - * @param {Array.=} opt_activeTrackIds + * @param {Array=} opt_activeTrackIds * @param {chrome.cast.media.TextTrackStyle=} opt_textTrackStyle * @constructor * @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.EditTracksInfoRequest @@ -826,11 +844,11 @@ declare module chrome.cast.media { images: Array; metadataType: chrome.cast.media.MetadataType; releaseDate: string; + /** @deprecated. Use releaseDate instead. */ releaseYear: number; subtitle: string; title: string; - - /** Deprecated. Use metadataType instead. */ + /** @deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; } @@ -844,12 +862,12 @@ declare module chrome.cast.media { images: Array; metadataType: chrome.cast.media.MetadataType; releaseDate: string; + /** @deprecated. Use releaseDate instead. */ releaseYear: number; subtitle: string; title: string; studio: string; - - /** Deprecated. Use metadataType instead. */ + /** @deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; } @@ -868,11 +886,15 @@ declare module chrome.cast.media { images: Array; originalAirdate: string; - /** Deprecated. Use metadataType instead. */ + /** @deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; + /** @deprecated. Use title instead. */ episodeTitle: string; + /** @deprecated. Use season instead. */ seasonNumber: number; + /** @deprecated. Use episode instead. */ episodeNumber: number; + /** @deprecated. Use originalAirdate instead. */ releaseYear: number; } @@ -895,9 +917,11 @@ declare module chrome.cast.media { images: Array; releaseDate: string; - /** Deprecated. Use metadataType instead. */ + /** @deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; + /** @deprecated. Use artist instead. */ artistName: string; + /** @deprecated. Use releaseDate instead. */ releaseYear: number; } @@ -919,7 +943,7 @@ declare module chrome.cast.media { height: number; creationDateTime: string; - /** Deprecated. Use metadataType instead. */ + /** @deprecated. Use metadataType instead. */ type: chrome.cast.media.MetadataType; } @@ -973,7 +997,7 @@ declare module chrome.cast.media { supportedMediaCommands: Array; volume: chrome.cast.Volume; - /** Deprecated. Use getEstimatedTime instead */ + /** @deprecated. Use getEstimatedTime instead */ currentTime: number; /**