vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 23:07:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chromecast-caf-receiver: Update messages and interceptor (#40369)

Browse Source 
* Update messages and interceptor

* Update message interceptor parameter name
This commit is contained in:
Brandon Risell
2019-11-13 15:29:13 -08:00
committed by Pranav Senthilnathan
parent e17b6365fc
commit b907c0ca82
4 changed files with 550 additions and 259 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/chromecast-caf-receiver/cast.framework.d.ts
Vendored
+218 -7
View File
@@ -644,17 +644,228 @@ export class PlayerManager {
setMediaUrlResolver(resolver: (loadRequestData: messages.LoadRequestData) => void): void;
/**
* Provide an interceptor of incoming and outgoing messages.
* The interceptor can update the request data and return updated data,
* a promise of updated data if need to get more data from the server,
* or null if the request should not be handled.
* If the load message interceptor is provided and no interceptor is provided for preload, the load interceptor will be called for preload messages.
* Provide an interceptor of incoming and outgoing messages. The interceptor
* can update the request data, and return updated data, a promise of
* updated data if need to get more data from the server, or null if the
* request should not be handled. Note that if load message interceptor is
* provided, and no interceptor is provided for preload - the load
* interceptor will be called for preload messages.
*/
setMessageInterceptor(
type: messages.MessageType.CLOUD_STATUS,
interceptor:
| ((messageData: messages.CloudMediaStatus) => messages.CloudMediaStatus)
| ((messageData: messages.CloudMediaStatus) => Promise<messages.CloudMediaStatus>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.CUSTOM_COMMAND,
interceptor:
| ((messageData: messages.CustomCommandRequestData) => messages.CustomCommandRequestData)
| ((messageData: messages.CustomCommandRequestData) => Promise<messages.CustomCommandRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.DISPLAY_STATUS,
interceptor:
| ((messageData: messages.DisplayStatusRequestData) => messages.DisplayStatusRequestData)
| ((messageData: messages.DisplayStatusRequestData) => Promise<messages.DisplayStatusRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.EDIT_AUDIO_TRACKS,
interceptor:
| ((messageData: messages.EditAudioTracksRequestData) => messages.EditAudioTracksRequestData)
| ((messageData: messages.EditAudioTracksRequestData) => Promise<messages.EditAudioTracksRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.EDIT_TRACKS_INFO,
interceptor:
| ((messageData: messages.EditTracksInfoRequestData) => messages.EditTracksInfoRequestData)
| ((messageData: messages.EditTracksInfoRequestData) => Promise<messages.EditTracksInfoRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.FOCUS_STATE,
interceptor:
| ((messageData: messages.FocusStateRequestData) => messages.FocusStateRequestData)
| ((messageData: messages.FocusStateRequestData) => Promise<messages.FocusStateRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.GET_STATUS,
interceptor:
| ((messageData: messages.GetStatusRequestData) => messages.GetStatusRequestData)
| ((messageData: messages.GetStatusRequestData) => Promise<messages.GetStatusRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.LOAD,
interceptor:
| ((messageData: messages.LoadRequestData) => messages.LoadRequestData)
| ((messageData: messages.LoadRequestData) => Promise<messages.LoadRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.LOAD_BY_ENTITY,
interceptor:
| ((messageData: messages.LoadByEntityRequestData) => messages.LoadByEntityRequestData)
| ((messageData: messages.LoadByEntityRequestData) => Promise<messages.LoadByEntityRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.MEDIA_STATUS,
interceptor:
| ((messageData: messages.MediaStatus) => messages.MediaStatus)
| ((messageData: messages.MediaStatus) => Promise<messages.MediaStatus>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.PRECACHE,
interceptor:
| ((messageData: messages.PrecacheRequestData) => messages.PrecacheRequestData)
| ((messageData: messages.PrecacheRequestData) => Promise<messages.PrecacheRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.PRELOAD,
interceptor:
| ((messageData: messages.PreloadRequestData) => messages.PreloadRequestData)
| ((messageData: messages.PreloadRequestData) => Promise<messages.PreloadRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_CHANGE,
interceptor:
| ((messageData: messages.QueueChange) => messages.QueueChange)
| ((messageData: messages.QueueChange) => Promise<messages.QueueChange>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_GET_ITEMS,
interceptor:
| ((messageData: messages.GetItemsInfoRequestData) => messages.GetItemsInfoRequestData)
| ((messageData: messages.GetItemsInfoRequestData) => Promise<messages.GetItemsInfoRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_GET_ITEM_RANGE,
interceptor:
| ((messageData: messages.FetchItemsRequestData) => messages.FetchItemsRequestData)
| ((messageData: messages.FetchItemsRequestData) => Promise<messages.FetchItemsRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_INSERT,
interceptor:
| ((messageData: messages.QueueInsertRequestData) => messages.QueueInsertRequestData)
| ((messageData: messages.QueueInsertRequestData) => Promise<messages.QueueInsertRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_ITEMS,
interceptor:
| ((messageData: messages.ItemsInfo) => messages.ItemsInfo)
| ((messageData: messages.ItemsInfo) => Promise<messages.ItemsInfo>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_ITEM_IDS,
interceptor:
| ((messageData: messages.QueueIds) => messages.QueueIds)
| ((messageData: messages.QueueIds) => Promise<messages.QueueIds>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_LOAD,
interceptor:
| ((messageData: messages.QueueLoadRequestData) => messages.QueueLoadRequestData)
| ((messageData: messages.QueueLoadRequestData) => Promise<messages.QueueLoadRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_REMOVE,
interceptor:
| ((messageData: messages.QueueRemoveRequestData) => messages.QueueRemoveRequestData)
| ((messageData: messages.QueueRemoveRequestData) => Promise<messages.QueueRemoveRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_REORDER,
interceptor:
| ((messageData: messages.QueueReorderRequestData) => messages.QueueReorderRequestData)
| ((messageData: messages.QueueReorderRequestData) => Promise<messages.QueueReorderRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.QUEUE_UPDATE,
interceptor:
| ((messageData: messages.QueueUpdateRequestData) => messages.QueueUpdateRequestData)
| ((messageData: messages.QueueUpdateRequestData) => Promise<messages.QueueUpdateRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.RESUME_SESSION,
interceptor:
| ((messageData: messages.ResumeSessionRequestData) => messages.ResumeSessionRequestData)
| ((messageData: messages.ResumeSessionRequestData) => Promise<messages.ResumeSessionRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.SEEK,
interceptor:
| ((messageData: messages.SeekRequestData) => messages.SeekRequestData)
| ((messageData: messages.SeekRequestData) => Promise<messages.SeekRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.SESSION_STATE,
interceptor:
| ((messageData: messages.StoreSessionResponseData) => messages.StoreSessionResponseData)
| ((messageData: messages.StoreSessionResponseData) => Promise<messages.StoreSessionResponseData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.SET_CREDENTIALS,
interceptor:
| ((messageData: messages.SetCredentialsRequestData) => messages.SetCredentialsRequestData)
| ((messageData: messages.SetCredentialsRequestData) => Promise<messages.SetCredentialsRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.SET_PLAYBACK_RATE,
interceptor:
| ((messageData: messages.SetPlaybackRateRequestData) => messages.SetPlaybackRateRequestData)
| ((messageData: messages.SetPlaybackRateRequestData) => Promise<messages.SetPlaybackRateRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.SET_VOLUME,
interceptor:
| ((messageData: messages.VolumeRequestData) => messages.VolumeRequestData)
| ((messageData: messages.VolumeRequestData) => Promise<messages.VolumeRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.STORE_SESSION,
interceptor:
| ((messageData: messages.StoreSessionRequestData) => messages.StoreSessionRequestData)
| ((messageData: messages.StoreSessionRequestData) => Promise<messages.StoreSessionRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType.USER_ACTION,
interceptor:
| ((messageData: messages.UserActionRequestData) => messages.UserActionRequestData)
| ((messageData: messages.UserActionRequestData) => Promise<messages.UserActionRequestData>)
| null,
): void;
setMessageInterceptor(
type: messages.MessageType,
interceptor:
| ((requestData: messages.RequestData) => messages.RequestData)
| ((requestData: messages.RequestData) => Promise<any>)
| ((messageData: messages.RequestData) => messages.RequestData)
| ((messageData: messages.RequestData) => Promise<messages.RequestData>)
| null,
): void;
types/chromecast-caf-receiver/cast.framework.messages.d.ts
Vendored
+300 -250
View File
@@ -1,4 +1,4 @@
import { Event, DetailedErrorCode } from './cast.framework.events';
import { DetailedErrorCode, Event, EventType } from './cast.framework.events';
export as namespace messages;
@@ -498,10 +498,17 @@ export class VastAdsRequest {
/**
* UserAction request data.
*/
export class UserActionRequestData {
export class UserActionRequestData extends RequestData {
constructor()
/**
* Optional request source.
* It contain the assistent query that initiate the request.
* Indicate request for clearing of a user action (i.e. undo like).
*/
clear?: boolean;
/**
* Optional request source. It contain the assistent query that initiate the
* request.
*/
source?: string;
@@ -687,6 +694,28 @@ export class TextTrackStyle {
windowType?: TextTrackWindowType;
}
/**
* Response data for SESSION_STATE command.
*/
export class StoreSessionResponseData extends RequestData {
/**
* @param sessionState The SessionState object to be returned.
*/
constructor(sessionState: SessionState);
/**
* The SessionState object to be returned.
*/
sessionState: SessionState;
}
/**
* STORE_SESSION request data
*/
export class StoreSessionRequestData extends RequestData {
constructor();
}
/**
* Media event playback rate request data.
*/
@@ -699,10 +728,10 @@ export class SetPlaybackRateRequestData extends RequestData {
playbackRate?: number;
/**
* New playback rate relative to current playback rate.
* New rate will be the result of multiplying the current rate with the value.
* For example a value of 1.1 will increase rate by 10%.
* (Only used if the playbackRate value is not provided).
* New playback rate relative to current playback rate. New rate will be the
* result of multiplying the current rate with the value. For example a
* value of 1.1 will increase rate by 10%. (Only used if the playbackRate
* value is not provided).
*/
relativePlaybackRate?: number;
}
@@ -711,23 +740,42 @@ export class SetPlaybackRateRequestData extends RequestData {
* SetCredentials request data.
*/
export class SetCredentialsRequestData extends RequestData {
constructor()
/**
* Credentials to use by receiver.
*/
credentials?: string;
/**
* If it is a response for refresh credentials; it will indicate the request id
* of the refresh credentials request.
* If it is a response for refresh credentials, it will indicate the request
* id of the refresh credentials request.
*/
forRequestId?: number;
/**
* Optional request source. It contain the assistent query that initiate the request.
* Optional request source. It contain the assistent query that initiate the
* request.
*/
source?: string;
}
/**
* A state object containing all data to be stored in StoreSession and to be
* recovered in ResumeSession.
* [Description]{@link https://developers.google.com/cast/docs/reference/caf_receiver/cast.framework.messages.SessionState.html}
*/
export class SessionState {
constructor();
/**
* Customizable object for storing the state.
*/
customData?: object;
loadRequestData?: LoadRequestData;
}
/**
* Media event SEEK request data.
*/
@@ -740,8 +788,8 @@ export class SeekRequestData extends RequestData {
currentTime?: number;
/**
* Seconds relative to the current playback position. If this field is defined;
* the currentTime field will be ignored.
* Seconds relative to the current playback position. If this field is
* defined, the currentTime field will be ignored.
*/
relativeTime?: number;
@@ -768,11 +816,23 @@ export class SeekableRange {
start?: number;
}
/**
* RESUME_SESSION request data
*/
export class ResumeSessionRequestData extends RequestData {
constructor();
/**
* The SessionState object returned by StoreSession command.
*/
sessionState?: SessionState;
}
/**
* Media event request data.
*/
export class RequestData {
constructor(type: MessageType);
constructor(type: MessageType | EventType);
/**
* Application-specific data for this request.
@@ -790,42 +850,49 @@ export class RequestData {
* Id of the request; used to correlate request/response.
*/
requestId: number;
/**
* Message type.
*/
type: MessageType | EventType;
}
/**
* Media event UPDATE queue request data.
*/
export class QueueUpdateRequestData extends RequestData {
constructor();
/**
* ID of the current media Item after the deletion
* (if not provided; the currentItem value will be the same as before the deletion;
* if it does not exist because it has been deleted; the currentItem will point to
* the next logical item in the list).
* ID of the current media Item after the changes (if not provided or not
* found, the currentItem value will be the same as before the update).
*/
currentItemId?: number;
/**
* Seconds since the beginning of content to start playback of the current item.
* If provided; this value will take precedence over the startTime value provided
* at the QueueItem level but only the first time the item is played.
* This is to cover the common case where the user jumps to the middle of an
* item so the currentTime does not apply to the item permanently like the
* QueueItem startTime does. It avoids having to reset the startTime dynamically
* (that may not be possible if the phone has gone to sleep).
* Seconds since the beginning of content to start playback of the current
* item. If provided, this value will take precedence over the startTime
* value provided at the QueueItem level but only the first time the item is
* played. This is to cover the common case where the user jumps to the
* middle of an item so the currentTime does not apply to the item
* permanently like the QueueItem startTime does. It avoids having to reset
* the startTime dynamically (that may not be possible if the phone has gone
* to sleep).
*/
currentTime?: number;
/**
* List of queue items to be updated. No reordering will happen; the items will
* retain the existing order.
* List of queue items to be updated. No reordering will happen, the items
* will retain the existing order.
*/
items?: QueueItem[];
/**
* Skip/Go back number of items with respect to the position of currentItem
* (it can be negative). If it is out of boundaries; the currentItem will be the
* next logical item in the queue wrapping around the boundaries.
* The new currentItem position will follow the rules of the queue repeat behavior.
* (it can be negative). If it is out of boundaries, the currentItem will be
* the next logical item in the queue wrapping around the boundaries. The
* new currentItem position will follow the rules of the queue repeat
* behavior.
*/
jump?: number;
@@ -835,9 +902,8 @@ export class QueueUpdateRequestData extends RequestData {
repeatMode?: RepeatMode;
/**
* Shuffle the queue items when the update is processed.
* After the queue items are shuffled; the item at the currentItem position will
* be loaded.
* Shuffle the queue items when the update is processed. After the queue
* items are shuffled, the item at the currentItem position will be loaded.
*/
shuffle?: boolean;
}
@@ -893,70 +959,79 @@ export class QueueReorderRequestData extends RequestData {
* Media event queue REMOVE request data.
*/
export class QueueRemoveRequestData extends RequestData {
/**
* @param itemIds IDs of queue items to be deleted.
*/
constructor(itemIds: number[]);
/**
* ID of the current media Item after the deletion
* (if not provided; the currentItem value will be the same as before the deletion;
* if it does not exist because it has been deleted;
* the currentItem will point to the next logical item in the list).
* ID of the current media Item after the deletion (if not provided, the
* currentItem value will be the same as before the deletion; if it does not
* exist because it has been deleted, the currentItem will point to the next
* logical item in the list).
*/
currentItemId?: number;
/**
* Seconds since the beginning of content to start playback of the current item.
* If provided; this value will take precedence over the startTime value provided
* at the QueueItem level but only the first time the item is played.
* This is to cover the common case where the user jumps to the middle of an
* item so the currentTime does not apply to the item permanently like the
* QueueItem startTime does. It avoids having to reset the startTime dynamically
* (that may not be possible if the phone has gone to sleep).
* Seconds since the beginning of content to start playback of the current
* item. If provided, this value will take precedence over the startTime
* value provided at the QueueItem level but only the first time the item is
* played. This is to cover the common case where the user jumps to the
* middle of an item so the currentTime does not apply to the item
* permanently like the QueueItem startTime does. It avoids having to reset
* the startTime dynamically (that may not be possible if the phone has gone
* to sleep).
*/
currentTime?: number;
/**
* IDs of queue items to be deleted.
*/
itemIds?: number[];
itemIds: number[];
}
/**
* Media event queue LOAD request data.
*/
export class QueueLoadRequestData extends RequestData {
/**
* @param items List of queue items. The itemId field of the items should be
* empty or the request will fail with an INVALID_PARAMS error. It is sorted
* (first element will be played first).
*/
constructor(items: QueueItem[]);
/**
* Seconds (since the beginning of content) to start playback of the first item to
* be played. If provided; this value will take precedence over the
* startTime value provided at the QueueItem level but only the first
* time the item is played. This is to cover the common case where the user
* casts the item that was playing locally so the currentTime does not apply
* to the item permanently like the QueueItem startTime does.
* It avoids having to reset the startTime dynamically
* (that may not be possible if the phone has gone to sleep).
* Seconds (since the beginning of content) to start playback of the first
* item to be played. If provided, this value will take precedence over the
* startTime value provided at the QueueItem level but only the first time
* the item is played. This is to cover the common case where the user casts
* the item that was playing locally so the currentTime does not apply to
* the item permanently like the QueueItem startTime does. It avoids having
* to reset the startTime dynamically (that may not be possible if the phone
* has gone to sleep).
*/
currentTime?: number;
/**
* Behavior of the queue when all items have been played.
* Array of queue items. It is sorted (first element will be played first).
*/
items: QueueItem[];
/**
* Id of the request; used to correlate request/response.
* Behavior of the queue when all items have been played.
*/
repeatMode?: RepeatMode;
/**
* The index of the item in the items array that must be the first currentItem
* (the item that will be played first). Note this is the index of the array
* (starts at 0) and not the itemId (as it is not known until the queue is created).
* If repeatMode is REPEAT_OFF playback will end when the last item in the array is
* played (elements before the startIndex will not be played).
* This may be useful for continuation scenarios where the user was already
* using the sender app and in the middle decides to cast.
* In this way the sender app does not need to map between the local and remote queue
* positions or saves one extra QUEUE_UPDATE request.
* The index of the item in the items array that must be the first
* currentItem (the item that will be played first). Note this is the index
* of the array (starts at 0) and not the itemId (as it is not known until
* the queue is created). If repeatMode is REPEAT_OFF playback will end when
* the last item in the array is played (elements before the startIndex will
* not be played). This may be useful for continuation scenarios where the
* user was already using the sender app and in the middle decides to cast.
* In this way the sender app does not need to map between the local and
* remote queue positions or saves one extra QUEUE_UPDATE request.
*/
startIndex?: number;
}
@@ -1038,45 +1113,52 @@ export class QueueItem {
* Media event queue INSERT request data.
*/
export class QueueInsertRequestData extends RequestData {
/**
* @param items List of queue items. The itemId field of the items should be
* empty or the request will fail with an INVALID_PARAMS error. It is sorted
* (first element will be played first).
*/
constructor(items: QueueItem[]);
/**
* ID of the current media Item after the insertion (if not provided;
* the currentItem value will be the same as before the insertion).
* ID of the current media Item after the insertion (if not provided, the
* currentItem value will be the same as before the insertion).
*/
currentItemId?: number;
/**
* Index (relative to the items array; starting with 0) of the new current media Item.
* For inserted items we use the index (similar to startIndex in QUEUE_LOAD) and not
* currentItemId; because the itemId is unknown until the items are inserted.
* If not provided; the currentItem value will be the same as before the insertion
* (unless currentItemId is provided). This param allows to make atomic the common use
* case of insert and play an item.
* Index (relative to the items array, starting with 0) of the new current
* media Item. For inserted items we use the index (similar to startIndex in
* QUEUE_LOAD) and not currentItemId, because the itemId is unknown until
* the items are inserted. If not provided, the currentItem value will be
* the same as before the insertion (unless currentItemId is provided). This
* param allows to make atomic the common use case of insert and play an
* item.
*/
currentItemIndex?: number;
/**
* Seconds since the beginning of content to start playback of the current item.
* If provided; this value will take precedence over the startTime value provided
* at the QueueItem level but only the first time the item is played.
* This is to cover the common case where the user jumps to the middle of an
* item so the currentTime does not apply to the item permanently like the
* QueueItem startTime does. It avoids having to reset the startTime dynamically
* (that may not be possible if the phone has gone to sleep).
* Seconds since the beginning of content to start playback of the current
* item. If provided, this value will take precedence over the startTime
* value provided at the QueueItem level but only the first time the item is
* played. This is to cover the common case where the user jumps to the
* middle of an item so the currentTime does not apply to the item
* permanently like the QueueItem startTime does. It avoids having to reset
* the startTime dynamically (that may not be possible if the phone has gone
* to sleep).
*/
currentTime?: number;
/**
* ID of the item that will be located immediately after the inserted list.
* If the ID is not found or it is not provided; the list will be appended at
* the end of the existing list.
* If the ID is not found or it is not provided, the list will be appended
* at the end of the existing list.
*/
insertBefore?: number;
/**
* List of queue items. The itemId field of the items should be empty.
* It is sorted (first element will be played first).
* List of queue items. The itemId field of the items should be empty. It is
* sorted (first element will be played first).
*/
items: QueueItem[];
}
@@ -1085,6 +1167,8 @@ export class QueueInsertRequestData extends RequestData {
* Represents a data message containing the full list of queue ids.
*/
export class QueueIds {
constructor()
/**
* List of queue item ids.
*/
@@ -1095,6 +1179,9 @@ export class QueueIds {
*/
requestId?: number;
/**
* Message type.
*/
type: MessageType;
}
@@ -1200,9 +1287,11 @@ export class QueueData {
}
/**
* Represents a queue change message; such as insert; remove; and update.
* Represents a queue change message, such as insert, remove, and update.
*/
export class QueueChange {
constructor()
/**
* The actual queue change type.
*/
@@ -1229,6 +1318,9 @@ export class QueueChange {
*/
sequenceNumber?: number;
/**
* Message type.
*/
type: MessageType;
}
@@ -1237,58 +1329,8 @@ export class QueueChange {
*/
export class PreloadRequestData extends LoadRequestData {
/**
* Array of trackIds that are active. If the array is not provided;
* the default tracks will be active.
* @param itemId The ID of the queue item.
*/
activeTrackIds: number[];
/**
* If the autoplay parameter is specified; the media player will begin playing
* the content when it is loaded. Even if autoplay is not specified;the media player
* implementation may choose to begin playback immediately.
*/
autoplay?: boolean;
/**
* Optional user credentials.
*/
credentials?: string;
/**
* Optional credentials type. The type 'cloud' is a reserved type used by load
* requests that were originated by voice assistant commands.
*/
credentialsType?: string;
/**
* Seconds since beginning of content. If the content is live content;
* and currentTime is not specified; the stream will start at the live position.
*/
currentTime?: number;
/**
* If the autoplay parameter is specified; the media player will begin playing
* the content when it is loaded. Even if autoplay is not specified; the media
* player implementation may choose to begin playback immediately.
*/
media: MediaInformation;
/**
* The media playback rate.
*/
playbackRate?: number;
/**
* Queue data.
*/
queueData: QueueData;
/**
* Application-specific data for this request.
* It enables the sender and receiver to easily extend the media protocol
* without having to use a new namespace with custom messages.
*/
customData?: any;
/**
* Id of the media session that the request applies to.
*/
mediaSessionId?: number;
/**
* Id of the request; used to correlate request/response.
*/
requestId: number;
constructor(itemId: number);
/**
@@ -1298,64 +1340,14 @@ export class PreloadRequestData extends LoadRequestData {
}
/**
* Media event PRECACHE request data. (Some fields of the load request;
* like autoplay and queueData; are ignored).
* Media event PRECACHE request data. (Some fields of the load request, like
* autoplay and queueData, are ignored).
*/
export class PrecacheRequestData extends LoadRequestData {
/**
* Array of trackIds that are active. If the array is not provided;
* the default tracks will be active.
* @param data Application precache data.
*/
activeTrackIds: number[];
/**
* If the autoplay parameter is specified; the media player will begin playing
* the content when it is loaded. Even if autoplay is not specified;the media player
* implementation may choose to begin playback immediately.
*/
autoplay?: boolean;
/**
* Optional user credentials.
*/
credentials?: string;
/**
* Optional credentials type. The type 'cloud' is a reserved type used by load
* requests that were originated by voice assistant commands.
*/
credentialsType?: string;
/**
* Seconds since beginning of content. If the content is live content; and
* currentTime is not specified; the stream will start at the live position.
*/
currentTime?: number;
/**
* If the autoplay parameter is specified; the media player will begin playing
* the content when it is loaded. Even if autoplay is not specified;
* the media player implementation may choose to begin playback immediately.
*/
media: MediaInformation;
/**
* The media playback rate.
*/
playbackRate?: number;
/**
* Queue data.
*/
queueData: QueueData;
/**
* Application-specific data for this request.
* It enables the sender and receiver to easily extend the media protocol
* without having to use a new namespace with custom messages.
*/
customData?: any;
/**
* Id of the media session that the request applies to.
*/
mediaSessionId?: number;
/**
* Id of the request; used to correlate request/response.
*/
requestId: number;
constructor(data?: string);
constructor(data?: string)
/**
* Application precache data.
@@ -1531,20 +1523,24 @@ export class MovieMediaMetadata {
*/
title?: string;
}
/**
* Represents the status of a media session.
* [Documentation]{@link https://developers.google.com/cast/docs/reference/caf_receiver/cast.framework.messages.MediaStatus}
*/
export class MediaStatus {
constructor();
/**
* List of IDs corresponding to the active tracks.
*/
activeTrackIds: number[];
activeTrackIds?: number[];
/**
* Status of break; if receiver is playing break.
* This field will be defined only when receiver is playing break.
* Status of break, if receiver is playing break. This field will be defined
* only when receiver is playing break.
*/
breakStatus: BreakStatus;
breakStatus?: BreakStatus;
/**
* ID of this media item (the item that originated the status change).
@@ -1564,26 +1560,26 @@ export class MediaStatus {
/**
* Extended media status information.
*/
extendedStatus: ExtendedMediaStatus;
extendedStatus?: ExtendedMediaStatus;
/**
* If the state is IDLE; the reason the player went to IDLE state.
* If the state is IDLE, the reason the player went to IDLE state.
*/
idleReason: IdleReason;
idleReason?: IdleReason;
/**
* List of media queue items.
*/
items: QueueItem[];
items?: QueueItem[];
/**
* Seekable range of a live or event stream. It uses relative media time in seconds.
* It will be undefined for VOD streams.
* Seekable range of a live or event stream. It uses relative media time in
* seconds. It will be undefined for VOD streams.
*/
liveSeekableRange: LiveSeekableRange;
liveSeekableRange?: LiveSeekableRange;
/**
* ID of the media Item currently loading. If there is no item being loaded;
* ID of the media Item currently loading. If there is no item being loaded,
* it will be undefined.
*/
loadingItemId?: number;
@@ -1591,7 +1587,7 @@ export class MediaStatus {
/**
* The media information.
*/
media: MediaInformation;
media?: MediaInformation;
/**
* Unique id for the session.
@@ -1609,40 +1605,44 @@ export class MediaStatus {
playerState: PlayerState;
/**
* ID of the next Item; only available if it has been preloaded.
* Media items can be preloaded and cached temporarily in memory;
* so when they are loaded later on; the process is faster
* (as the media does not have to be fetched from the network).
* ID of the next Item, only available if it has been preloaded. Media items
* can be preloaded and cached temporarily in memory, so when they are
* loaded later on, the process is faster (as the media does not have to be
* fetched from the network).
*/
preloadedItemId?: number;
/**
* Queue data.
*/
queueData: QueueData;
queueData?: QueueData;
/**
* The behavior of the queue when all items have been played.
*/
repeatMode: RepeatMode;
repeatMode?: RepeatMode;
/**
* The commands supported by this player.
*/
supportedMediaCommands: number;
/**
* Message type.
*/
type: MessageType;
/**
* The video information.
*/
videoInfo: VideoInformation;
videoInfo?: VideoInformation;
/**
* The current stream volume.
*/
volume: Volume;
}
/**
* Common media metadata used as part of MediaInformation
*/
@@ -1748,16 +1748,15 @@ export class LoadRequestData extends RequestData {
constructor();
/**
* Array of trackIds that are active. If the array is not provided; the
* Array of trackIds that are active. If the array is not provided, the
* default tracks will be active.
*/
activeTrackIds: number[];
/**
* If the autoplay parameter is specified; the media player will begin
* playing the content when it is loaded. Even if autoplay is not
* specified;the media player implementation may choose to begin playback
* immediately.
* If the autoplay parameter is specified, the media player will begin
* playing the content when it is loaded. Even if autoplay is not specified,
* the media player implementation may choose to begin playback immediately.
*/
autoplay?: boolean;
@@ -1773,15 +1772,20 @@ export class LoadRequestData extends RequestData {
credentialsType?: string;
/**
* Seconds since beginning of content. If the content is live content;
* and currentTime is not specified; the stream will start at the live position.
* Seconds since beginning of content. If the content is live content, and
* currentTime is not specified, the stream will start at the live position.
*/
currentTime?: number;
/**
* If the autoplay parameter is specified; the media player will begin playing
* the content when it is loaded. Even if autoplay is not specified; the media
* player implementation may choose to begin playback immediately.
* Added load options.
*/
loadOptions?: LoadOptions;
/**
* If the autoplay parameter is specified, the media player will begin
* playing the content when it is loaded. Even if autoplay is not specified,
* the media player implementation may choose to begin playback immediately.
*/
media: MediaInformation;
@@ -1796,6 +1800,18 @@ export class LoadRequestData extends RequestData {
queueData: QueueData;
}
/**
* Provides additional options for load requests.
*/
export class LoadOptions {
constructor();
/**
* The content filtering mode to apply for which items to play.
*/
contentFilteringMode?: ContentFilteringMode;
}
/**
* LoadByEntity request data.
*/
@@ -1841,16 +1857,21 @@ export class LiveSeekableRange {
* Represents a data message containing item information for each requested ids.
*/
export class ItemsInfo {
constructor()
/**
* List of changed itemIds.
*/
items: QueueItem[];
items?: QueueItem[];
/**
* The corresponding request id.
*/
requestId?: number;
/**
* Message type.
*/
type: MessageType;
}
@@ -1883,7 +1904,7 @@ export class GetStatusRequestData extends RequestData {
/**
* The options of a GET_STATUS request.
*/
options: GetStatusOptions;
options?: GetStatusOptions;
}
/**
@@ -1933,11 +1954,13 @@ export class GenericMediaMetadata extends MediaMetadata {
/**
* Focus state change message.
*/
export class FocusStateRequestData {
export class FocusStateRequestData extends RequestData {
constructor();
/**
* The focus state of the app.
*/
state: FocusState;
state?: FocusState;
}
/** Fetch items request data. */
@@ -2005,79 +2028,106 @@ export class ErrorData {
requestId?: number;
}
/** Media event EDIT_TRACKS_INFO request data. */
/**
* Media event EDIT_TRACKS_INFO request data.
*/
export class EditTracksInfoRequestData extends RequestData {
constructor();
/**
* Array of the Track trackIds that should be active.
* If it is not provided; the active tracks will not change.
* If the array is empty; no track will be active.
* Array of the `Track` `trackId`s that should be active. If it is not
* provided, the active tracks will not change. If the array is empty, no
* track will be active.
*/
activeTrackIds?: number[];
/**
* Flag to enable or disable text tracks.
* If false it will disable all text tracks;
* if true it will enable the first text track; or the previous active text tracks.
* This flag is ignored if activeTrackIds or language is provided.
* Flag to enable or disable text tracks. If `false` it will disable all
* text tracks. If `true` it will enable the first text track, or the
* previous active text tracks. This flag is ignored if `activeTrackIds` or
* `language` is provided.
*/
enableTextTracks?: boolean;
/**
* Indicates that the provided language was not explicit user request; but rather
* inferred from used language in voice query.
* It allows receiver apps to use user saved preference instead of spoken language.
* Indicates that the provided language was not an explicit user request,
* but rather inferred from used language in voice query. It allows receiver
* apps to use user saved preference instead of spoken language.
*/
isSuggestedLanguage?: boolean;
/**
* Language for the tracks that should be active. The language field will take
* precedence over activeTrackIds if both are specified.
* Language for the tracks that should be active. The language field will
* take precedence over activeTrackIds if both are specified.
*/
language?: string;
/**
* The requested text track style. If it is not provided the existing style
* will be used (if no style was provided in previous calls, it will be the
* default receiver style).
*/
textTrackStyle?: TextTrackStyle;
}
/**
* Media event EDIT_AUDIO_TRACKS request data. If language is not provided;
* the default audio track for the media will be enabled.
* Media event EDIT_AUDIO_TRACKS request data. If language is not provided the
* default audio track for the media will be enabled.
*/
export class EditAudioTracksRequestData extends RequestData {
constructor();
/**
* Indicates that the provided language was not explicit user request;
* but rather inferred from used language in voice query.
* It allows receiver apps to use user saved preference instead of spoken language.
* Indicates that the provided language was not an explicit user request,
* but rather inferred from used language in voice query. It allows receiver
* apps to use user saved preference instead of spoken language.
*/
isSuggestedLanguage?: boolean;
/**
* Language for the track that should be active.
* The language field will take precedence over `activeTrackIds` if both are
* specified.
*/
language?: string;
}
/** DisplayStatus request data. */
export class DisplayStatusRequestData {
/**
* DisplayStatus request data.
* Note as of November 2019: Docs don't mention this extending RequestData.
*/
export class DisplayStatusRequestData extends RequestData {
/**
* Optional request source. It contain the assistent query that initiate the request.
* Optional request source. It contains the assistant query that initiated
* the request.
*/
source: string;
source?: string;
}
/** CustomCommand request data. */
export class CustomCommandRequestData {
/**
* CustomCommand request data.
* Note as of November 2019: Docs don't mention this extending RequestData.
*/
export class CustomCommandRequestData extends RequestData {
/**
* Custom Data; typically represented by a stringified JSON object.
* Custom data typically represented by a stringified JSON object.
*/
data: string;
/**
* Optional request source. It contain the assistent query that initiate the request.
* Optional request source. It contains the assistant query that initiated
* the request.
*/
source: string;
source?: string;
}
/**
* Cloud media status. Media status that is only sent to the cloud sender.
* Note as of November 2019: This message's `type` parameter shows as
* `MEDIA_STATUS`, not `CLOUD_STATUS`.
*/
export class CloudMediaStatus extends MediaStatus {}
export class BreakStatus {
constructor(currentBreakTime: number, currentBreakClipTime: number);
types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts
+31 -1
View File
@@ -1,4 +1,13 @@
import { MediaMetadata, LoadRequestData, StreamType, HlsSegmentFormat, Track, TrackType } from 'chromecast-caf-receiver/cast.framework.messages';
import {
MediaMetadata,
LoadRequestData,
StreamType,
HlsSegmentFormat,
Track,
TrackType,
MessageType,
RequestData,
} from 'chromecast-caf-receiver/cast.framework.messages';
import { DetailedErrorCode, EventType } from 'chromecast-caf-receiver/cast.framework.events';
// The following test showcases how you can import individual types directly from the namespace:
@@ -24,6 +33,7 @@ const adBreak = new cast.framework.messages.Break('id', ['id'], 1);
// tslint:disable-next-line
const rEvent = new cast.framework.events.RequestEvent(EventType.BITRATE_CHANGED, {
requestId: 2,
type: EventType.BITRATE_CHANGED,
});
// tslint:disable-next-line
const pManager = new cast.framework.PlayerManager();
@@ -134,6 +144,7 @@ cast.framework.CastReceiverContext.getInstance().addEventListener(
const loadingError = new cast.framework.events.ErrorEvent(DetailedErrorCode.LOAD_FAILED, 'Loading failed!');
// PlayerManager message interceptors
cast.framework.CastReceiverContext.getInstance()
.getPlayerManager()
.setMessageInterceptor(cast.framework.messages.MessageType.LOAD, () => new Promise((resolve, reject) => {}));
@@ -143,3 +154,22 @@ cast.framework.CastReceiverContext.getInstance()
cast.framework.CastReceiverContext.getInstance()
.getPlayerManager()
.setMessageInterceptor(cast.framework.messages.MessageType.LOAD, null);
cast.framework.CastReceiverContext.getInstance()
.getPlayerManager()
.setMessageInterceptor(cast.framework.messages.MessageType.CUSTOM_COMMAND, customCommandRequestData => {
const data = customCommandRequestData.data;
return customCommandRequestData;
});
cast.framework.CastReceiverContext.getInstance()
.getPlayerManager()
.setMessageInterceptor(cast.framework.messages.MessageType.SET_VOLUME, volumeRequestData => {
const volume = volumeRequestData.volume;
return volumeRequestData;
});
// PlayerManager event listeners
cast.framework.CastReceiverContext.getInstance()
.getPlayerManager()
.addEventListener(cast.framework.events.EventType.BITRATE_CHANGED, bitrateChangedEvent => {
const bitrate = bitrateChangedEvent.totalBitrate;
});
types/chromecast-caf-receiver/index.d.ts
Vendored
+1 -1
View File
@@ -1,4 +1,4 @@
// Type definitions for non-npm package chromecast-caf-receiver 4.0
// Type definitions for non-npm package chromecast-caf-receiver 5.0
// Project: https://github.com/googlecast
// Definitions by: Sergio Arbeo <https://github.com/Serabe>
// Craig Bruce <https://github.com/craigrbruce>