forked from miloproductionsinc/cordova-plugin-chromecast
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathchrome.cast.js
1510 lines (1379 loc) · 64.2 KB
/
chrome.cast.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Portions of this page are modifications based on work created and shared by
* Google and used according to terms described in the Creative Commons 3.0
* Attribution License.
*/
var EventEmitter = require('cordova-plugin-chromecast.EventEmitter');
var chrome = {};
chrome.cast = {
/**
* The API version.
* @type {Array}
*/
VERSION: [1, 1],
/**
* Describes availability of a Cast receiver.
* AVAILABLE: At least one receiver is available that is compatible with the session request.
* UNAVAILABLE: No receivers are available.
* @type {Object}
*/
ReceiverAvailability: { AVAILABLE: 'available', UNAVAILABLE: 'unavailable' },
/**
* TODO: Update when the official API docs are finished
* https://developers.google.com/cast/docs/reference/chrome/chrome.cast.ReceiverType
* CAST:
* DIAL:
* CUSTOM:
* @type {Object}
*/
ReceiverType: { CAST: 'cast', DIAL: 'dial', CUSTOM: 'custom' },
/**
* Describes a sender application platform.
* CHROME:
* IOS:
* ANDROID:
* @type {Object}
*/
SenderPlatform: { CHROME: 'chrome', IOS: 'ios', ANDROID: 'android' },
/**
* Auto-join policy determines when the SDK will automatically connect a sender application to an existing session after API initialization.
* ORIGIN_SCOPED: Automatically connects when the session was started with the same appId and the same page origin (regardless of tab).
* PAGE_SCOPED: No automatic connection.
* TAB_AND_ORIGIN_SCOPED: Automatically connects when the session was started with the same appId, in the same tab and page origin.
* @type {Object}
*/
AutoJoinPolicy: { TAB_AND_ORIGIN_SCOPED: 'tab_and_origin_scoped', ORIGIN_SCOPED: 'origin_scoped', PAGE_SCOPED: 'page_scoped' },
/**
* Capabilities that are supported by the receiver device.
* AUDIO_IN: The receiver supports audio input (microphone).
* AUDIO_OUT: The receiver supports audio output.
* VIDEO_IN: The receiver supports video input (camera).
* VIDEO_OUT: The receiver supports video output.
* @type {Object}
*/
Capability: { VIDEO_OUT: 'video_out', AUDIO_OUT: 'audio_out', VIDEO_IN: 'video_in', AUDIO_IN: 'audio_in' },
/**
* Default action policy determines when the SDK will automatically create a session after initializing the API. This also controls the default action for the tab in the extension popup.
* CAST_THIS_TAB: No automatic launch is done after initializing the API, even if the tab is being cast.
* CREATE_SESSION: If the tab containing the app is being casted when the API initializes, the SDK stops tab casting and automatically launches the app.
* @type {Object}
*/
DefaultActionPolicy: { CREATE_SESSION: 'create_session', CAST_THIS_TAB: 'cast_this_tab' },
/**
* Errors that may be returned by the SDK.
* API_NOT_INITIALIZED: The API is not initialized.
* CANCEL: The operation was canceled by the user.
* CHANNEL_ERROR: A channel to the receiver is not available.
* EXTENSION_MISSING: The Cast extension is not available.
* EXTENSION_NOT_COMPATIBLE: The API script is not compatible with the installed Cast extension.
* INVALID_PARAMETER: The parameters to the operation were not valid.
* LOAD_MEDIA_FAILED: Load media failed.
* RECEIVER_UNAVAILABLE: No receiver was compatible with the session request.
* SESSION_ERROR: A session could not be created, or a session was invalid.
* TIMEOUT: The operation timed out.
* @type {Object}
*/
ErrorCode: {
API_NOT_INITIALIZED: 'api_not_initialized',
CANCEL: 'cancel',
CHANNEL_ERROR: 'channel_error',
EXTENSION_MISSING: 'extension_missing',
EXTENSION_NOT_COMPATIBLE: 'extension_not_compatible',
INVALID_PARAMETER: 'invalid_parameter',
LOAD_MEDIA_FAILED: 'load_media_failed',
RECEIVER_UNAVAILABLE: 'receiver_unavailable',
SESSION_ERROR: 'session_error',
TIMEOUT: 'timeout',
UNKNOWN: 'unknown',
NOT_IMPLEMENTED: 'not_implemented'
},
SessionStatus: { CONNECTED: 'connected', DISCONNECTED: 'disconnected', STOPPED: 'stopped' },
/**
* TODO: Update when the official API docs are finished
* https://developers.google.com/cast/docs/reference/chrome/chrome.cast.timeout
* @type {Object}
*/
timeout: {
requestSession: 10000,
sendCustomMessage: 3000,
setReceiverVolume: 3000,
stopSession: 3000
},
/**
* Flag for clients to check whether the API is loaded.
* @type {Boolean}
*/
isAvailable: false,
/**
* [ApiConfig description]
* @param {chrome.cast.SessionRequest} sessionRequest Describes the session to launch or the session to connect.
* @param {function} sessionListener Listener invoked when a session is created or connected by the SDK.
* @param {function} receiverListener Function invoked when the availability of a Cast receiver that supports the application in sessionRequest is known or changes.
* @param {chrome.cast.AutoJoinPolicy} autoJoinPolicy Determines whether the SDK will automatically connect to a running session after initialization.
* @param {chrome.cast.DefaultActionPolicy} defaultActionPolicy Requests whether the application should be launched on API initialization when the tab is already being cast.
*/
ApiConfig: function (sessionRequest, sessionListener, receiverListener, autoJoinPolicy, defaultActionPolicy) {
this.sessionRequest = sessionRequest;
this.sessionListener = sessionListener;
this.receiverListener = receiverListener;
this.autoJoinPolicy = autoJoinPolicy || chrome.cast.AutoJoinPolicy.TAB_AND_ORIGIN_SCOPED;
this.defaultActionPolicy = defaultActionPolicy || chrome.cast.DefaultActionPolicy.CREATE_SESSION;
},
/**
* TODO: Update when the official API docs are finished
* https://developers.google.com/cast/docs/reference/chrome/chrome.cast.DialRequest
* @param {[type]} appName [description]
* @param {[type]} launchParameter [description]
*/
DialRequest: function (appName, launchParameter) {
this.appName = appName;
this.launchParameter = launchParameter;
},
/**
* A request to start or connect to a session.
* @param {string} appId The receiver application id.
* @param {chrome.cast.Capability[]} capabilities Capabilities required of the receiver device.
* @property {chrome.cast.DialRequest} dialRequest If given, the SDK will also discover DIAL devices that support the DIAL application given in the dialRequest.
*/
SessionRequest: function (appId, capabilities) {
this.appId = appId;
this.capabilities = capabilities || [chrome.cast.Capability.VIDEO_OUT, chrome.cast.Capability.AUDIO_OUT];
this.dialRequest = null;
},
/**
* Describes an error returned by the API. Normally, these objects should not be created by the client.
* @param {chrome.cast.ErrorCode} code The error code.
* @param {string} description Human readable description of the error.
* @param {Object} details Details specific to the error.
*/
Error: function (code, description, details) {
this.code = code;
this.description = description || null;
this.details = details || null;
},
/**
* An image that describes a receiver application or media item. This could be an application icon, cover art, or a thumbnail.
* @param {string} url The URL to the image.
* @property {number} height The height of the image
* @property {number} width The width of the image
*/
Image: function (url) {
this.url = url;
this.width = this.height = null;
},
/**
* Describes a sender application. Normally, these objects should not be created by the client.
* @param {chrome.cast.SenderPlatform} platform The supported platform.
* @property {string} packageId The identifier or URL for the application in the respective platform's app store.
* @property {string} url URL or intent to launch the application.
*/
SenderApplication: function (platform) {
this.platform = platform;
this.packageId = this.url = null;
},
// media package
media: {
/**
* The default receiver app.
*/
DEFAULT_MEDIA_RECEIVER_APP_ID: 'CC1AD845',
/**
* Possible states of the media player.
* BUFFERING: Player is in PLAY mode but not actively playing content. currentTime will not change.
* IDLE: No media is loaded into the player.
* PAUSED: The media is not playing.
* PLAYING: The media is playing.
* @type {Object}
*/
PlayerState: { IDLE: 'IDLE', PLAYING: 'PLAYING', PAUSED: 'PAUSED', BUFFERING: 'BUFFERING' },
/**
* Possible reason why a media is idle.
* CANCELLED: A sender requested to stop playback using the STOP command.
* INTERRUPTED: A sender requested playing a different media using the LOAD command.
* FINISHED: The media playback completed.
* ERROR: The media was interrupted due to an error, this could be for example if the player could not download media due to networking errors.
*/
IdleReason: { CANCELLED: 'CANCELLED', INTERRUPTED: 'INTERRUPTED', FINISHED: 'FINISHED', ERROR: 'ERROR' },
/**
* Possible states of queue repeat mode.
* OFF: Items are played in order, and when the queue is completed (the last item has ended) the media session is terminated.
* ALL: The items in the queue will be played indefinitely. When the last item has ended, the first item will be played again.
* SINGLE: The current item will be repeated indefinitely.
* ALL_AND_SHUFFLE: The items in the queue will be played indefinitely. When the last item has ended, the list of items will be randomly shuffled by the receiver, and the queue will continue to play starting from the first item of the shuffled items.
*/
RepeatMode: { OFF: 'REPEAT_OFF', ALL: 'REPEAT_ALL', SINGLE: 'REPEAT_SINGLE', ALL_AND_SHUFFLE: 'REPEAT_ALL_AND_SHUFFLE' },
/**
* States of the media player after resuming.
* PLAYBACK_PAUSE: Force media to pause.
* PLAYBACK_START: Force media to start.
* @type {Object}
*/
ResumeState: { PLAYBACK_START: 'PLAYBACK_START', PLAYBACK_PAUSE: 'PLAYBACK_PAUSE' },
/**
* Possible media commands supported by the receiver application.
* @type {Object}
*/
MediaCommand: { PAUSE: 'pause', SEEK: 'seek', STREAM_VOLUME: 'stream_volume', STREAM_MUTE: 'stream_mute' },
/**
* Possible types of media metadata.
* GENERIC: Generic template suitable for most media types. Used by chrome.cast.media.GenericMediaMetadata.
* MOVIE: A full length movie. Used by chrome.cast.media.MovieMediaMetadata.
* MUSIC_TRACK: A music track. Used by chrome.cast.media.MusicTrackMediaMetadata.
* PHOTO: Photo. Used by chrome.cast.media.PhotoMediaMetadata.
* TV_SHOW: An episode of a TV series. Used by chrome.cast.media.TvShowMediaMetadata.
* @type {Object}
*/
MetadataType: { GENERIC: 0, MOVIE: 1, TV_SHOW: 2, MUSIC_TRACK: 3, PHOTO: 4, AUDIOBOOK_CHAPTER: 5 },
/**
* Possible media stream types.
* BUFFERED: Stored media streamed from an existing data store.
* LIVE: Live media generated on the fly.
* OTHER: None of the above.
* @type {Object}
*/
StreamType: { BUFFERED: 'buffered', LIVE: 'live', OTHER: 'other' },
/**
* TODO: Update when the official API docs are finished
* https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.timeout
* @type {Object}
*/
timeout: {
load: 0,
ob: 0,
pause: 0,
play: 0,
seek: 0,
setVolume: 0,
stop: 0
},
/**
* A request to load new media into the player.
* @param {chrome.cast.media.MediaInfo} media Media description.
* @property {boolean} autoplay Whether the media will automatically play.
* @property {number} currentTime Seconds from the beginning of the media to start playback.
* @property {Object} customData Custom data for the receiver application.
*/
LoadRequest: function LoadRequest (media) {
this.type = 'LOAD';
this.sessionId = this.requestId = this.customData = this.currentTime = null;
this.media = media;
this.autoplay = !0;
},
/**
* A request to play the currently paused media.
* @property {Object} customData Custom data for the receiver application.
*/
PlayRequest: function PlayRequest () {
this.customData = null;
},
/**
* A request to seek the current media.
* @property {number} currentTime The new current time for the media, in seconds after the start of the media.
* @property {chrome.cast.media.ResumeState} resumeState The desired media player state after the seek is complete.
* @property {Object} customData Custom data for the receiver application.
*/
SeekRequest: function SeekRequest () {
this.customData = this.resumeState = this.currentTime = null;
},
/**
* A request to set the stream volume of the playing media.
* @param {chrome.cast.Volume} volume The new volume of the stream.
* @property {Object} customData Custom data for the receiver application.
*/
VolumeRequest: function VolumeRequest (volume) {
this.volume = volume;
this.customData = null;
},
/**
* A request to stop the media player.
* @property {Object} customData Custom data for the receiver application.
*/
StopRequest: function StopRequest () {
this.customData = null;
},
/**
* A request to pause the currently playing media.
* @property {Object} customData Custom data for the receiver application.
*/
PauseRequest: function PauseRequest () {
this.customData = null;
},
/**
* Represents an item in a media queue.
* @param {chrome.cast.media.MediaInfo} mediaInfo - Value must not be null.
*/
QueueItem: function (item) {
this.itemId = null;
this.media = item;
this.autoplay = !0;
this.startTime = 0;
this.playbackDuration = null;
this.preloadTime = 0;
this.customData = this.activeTrackIds = null;
},
/**
* A request to load and optionally start playback of a new ordered
* list of media items.
* @param {chrome.cast.media.QueueItem} items - The list of media items
* to load. Must not be null or empty. Value must not be null.
*/
QueueLoadRequest: function (items) {
this.type = 'QUEUE_LOAD';
this.sessionId = this.requestId = null;
this.items = items;
this.startIndex = 0;
this.repeatMode = chrome.cast.media.RepeatMode.OFF;
this.customData = null;
},
/**
* An audiobook chapter description.
* @property {string} bookTitle Audiobook title.
* @property {number} chapterNumber Chapter number, used for display purposes.
* @property {string} chapterTitle Chapter title.
* @property {chrome.cast.Image[]} images Content images.
* @property {string} subtitle Content subtitle.
* @property {string} title Content title.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
*/
AudiobookChapterMediaMetadata: function GenericMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.AUDIOBOOK_CHAPTER;
this.bookTitle = this.chapterNumber = this.chapterTitle = this.images = this.subtitle = this.title = undefined;
},
/**
* A generic media description.
* @property {chrome.cast.Image[]} images Content images.
* @property {string} releaseDate ISO 8601 date and/or time when the content was released, e.g.
* @property {number} releaseYear Integer year when the content was released.
* @property {string} subtitle Content subtitle.
* @property {string} title Content title.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
*/
GenericMediaMetadata: function GenericMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.GENERIC;
this.releaseDate = this.releaseYear = this.images = this.subtitle = this.title = undefined;
},
/**
* A movie media description.
* @property {chrome.cast.Image[]} images Content images.
* @property {string} releaseDate ISO 8601 date and/or time when the content was released, e.g.
* @property {number} releaseYear Integer year when the content was released.
* @property {string} studio Movie studio
* @property {string} subtitle Content subtitle.
* @property {string} title Content title.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
*/
MovieMediaMetadata: function MovieMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.MOVIE;
this.releaseDate = this.releaseYear = this.images = this.subtitle = this.studio = this.title = undefined;
},
/**
* A music track media description.
* @property {string} albumArtist Album artist name.
* @property {string} albumName Album name.
* @property {string} artist Track artist name.
* @property {string} artistName Track artist name.
* @property {string} composer Track composer name.
* @property {number} discNumber Disc number.
* @property {chrome.cast.Image[]} images Content images.
* @property {string} releaseDate ISO 8601 date when the track was released, e.g.
* @property {number} releaseYear Integer year when the album was released.
* @property {string} songName Track name.
* @property {string} title Track title.
* @property {number} trackNumber Track number in album.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
*/
MusicTrackMediaMetadata: function MusicTrackMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.MUSIC_TRACK;
this.releaseDate = this.releaseYear = this.images = this.discNumber = this.trackNumber = this.artistName = this.songName = this.composer = this.artist = this.albumArtist = this.title = this.albumName = undefined;
},
/**
* A photo media description.
* @property {string} artist Name of the photographer.
* @property {string} creationDateTime ISO 8601 date and time the photo was taken, e.g.
* @property {number} height Photo height, in pixels.
* @property {chrome.cast.Image[]} images Images associated with the content.
* @property {number} latitude Latitude.
* @property {string} location Location where the photo was taken.
* @property {number} longitude Longitude.
* @property {string} title Photo title.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
* @property {number} width Photo width, in pixels.
*/
PhotoMediaMetadata: function PhotoMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.PHOTO;
this.creationDateTime = this.height = this.width = this.longitude = this.latitude = this.images = this.location = this.artist = this.title = undefined;
},
/**
* [TvShowMediaMetadata description]
* @property {number} episode TV episode number.
* @property {number} episodeNumber TV episode number.
* @property {string} episodeTitle TV episode title.
* @property {chrome.cast.Image[]} images Content images.
* @property {string} originalAirdate ISO 8601 date when the episode originally aired, e.g.
* @property {number} releaseYear Integer year when the content was released.
* @property {number} season TV episode season.
* @property {number} seasonNumber TV episode season.
* @property {string} seriesTitle TV series title.
* @property {string} title TV episode title.
* @property {chrome.cast.media.MetadataType} type The type of metadata.
*/
TvShowMediaMetadata: function TvShowMediaMetadata () {
this.metadataType = this.type = chrome.cast.media.MetadataType.TV_SHOW;
this.originalAirdate = this.releaseYear = this.images = this.episode = this.episodeNumber = this.season = this.seasonNumber = this.episodeTitle = this.title = this.seriesTitle = undefined;
},
/**
* Possible media track types.
*/
TrackType: {TEXT: 'TEXT', AUDIO: 'AUDIO', VIDEO: 'VIDEO'},
/**
* Possible text track types.
*/
TextTrackType: {SUBTITLES: 'SUBTITLES', CAPTIONS: 'CAPTIONS', DESCRIPTIONS: 'DESCRIPTIONS', CHAPTERS: 'CHAPTERS', METADATA: 'METADATA'},
/**
* Possible text track edge types.
*/
TextTrackEdgeType: {NONE: 'NONE', OUTLINE: 'OUTLINE', DROP_SHADOW: 'DROP_SHADOW', RAISED: 'RAISED', DEPRESSED: 'DEPRESSED'},
/**
* Possible text track font generic family.
*/
TextTrackFontGenericFamily: {
CURSIVE: 'CURSIVE',
MONOSPACED_SANS_SERIF: 'MONOSPACED_SANS_SERIF',
MONOSPACED_SERIF: 'MONOSPACED_SERIF',
SANS_SERIF: 'SANS_SERIF',
SERIF: 'SERIF',
SMALL_CAPITALS: 'SMALL_CAPITALS'
},
/**
* Possible text track font style.
*/
TextTrackFontStyle: {NORMAL: 'NORMAL', BOLD: 'BOLD', BOLD_ITALIC: 'BOLD_ITALIC', ITALIC: 'ITALIC'},
/**
* Possible text track window types.
*/
TextTrackWindowType: {NONE: 'NONE', NORMAL: 'NORMAL', ROUNDED_CORNERS: 'ROUNDED_CORNERS'},
/**
* Describes style information for a text track.
*
* Colors are represented as strings "#RRGGBBAA" where XX are the two hexadecimal symbols that represent
* the 0-255 value for the specific channel/color. It follows CSS 8-digit hex color notation (See
* http://dev.w3.org/csswg/css-color/#hex-notation).
*/
TextTrackStyle: function TextTrackStyle () {
this.backgroundColor = this.customData = this.edgeColor = this.edgeType =
this.fontFamily = this.fontGenericFamily = this.fontScale = this.fontStyle =
this.foregroundColor = this.windowColor = this.windowRoundedCornerRadius =
this.windowType = null;
},
/**
* A request to modify the text tracks style or change the tracks status. If a trackId does not match
* the existing trackIds the whole request will fail and no status will change. It is acceptable to
* change the text track style even if no text track is currently active.
* @param {number[]} opt_activeTrackIds Optional.
* @param {chrome.cast.media.TextTrackStyle} opt_textTrackSytle Optional.
**/
EditTracksInfoRequest: function EditTracksInfoRequest (opt_activeTrackIds, opt_textTrackSytle) {
this.activeTrackIds = opt_activeTrackIds;
this.textTrackSytle = opt_textTrackSytle;
this.requestId = null;
}
}
};
var _initialized = false;
var _sessionListener;
var _receiverListener;
var _session;
/**
* Initializes the API. Note that either successCallback and errorCallback will be invoked once the API has finished initialization.
* The sessionListener and receiverListener may be invoked at any time afterwards, and possibly more than once.
* @param {chrome.cast.ApiConfig} apiConfig The object with parameters to initialize the API. Must not be null.
* @param {function} successCallback
* @param {function} errorCallback
*/
chrome.cast.initialize = function (apiConfig, successCallback, errorCallback) {
if (apiConfig.sessionRequest.appId && 'warn' in window.console) {
console.warn('cordova-plugin-chromecast', 'The initialize command doesn\'t respect the `SessionId#appId` (see readme for more information)');
}
execute('initialize', apiConfig.autoJoinPolicy, apiConfig.defaultActionPolicy, function (err) {
if (!err) {
// Don't set the listeners config until success
_initialized = true;
_sessionListener = apiConfig.sessionListener;
_receiverListener = apiConfig.receiverListener;
successCallback();
_receiverListener && _receiverListener(chrome.cast.ReceiverAvailability.UNAVAILABLE);
} else {
handleError(err, errorCallback);
}
});
};
/**
* Requests that a receiver application session be created or joined.
* By default, the SessionRequest passed to the API at initialization time is used;
* this may be overridden by passing a different session request in opt_sessionRequest.
* @param {function} successCallback
* @param {function} errorCallback The possible errors are TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE, and EXTENSION_MISSING. Note that the timeout timer starts after users select a receiver. Selecting a receiver requires user's action, which has no timeout.
* @param {chrome.cast.SessionRequest} opt_sessionRequest
*/
chrome.cast.requestSession = function (successCallback, errorCallback, opt_sessionRequest) {
execute('requestSession', function (err, obj) {
if (!err) {
successCallback(createNewSession(obj));
} else {
handleError(err, errorCallback);
}
});
};
/**
* Describes the state of a currently running Cast application. Normally, these objects should not be created by the client.
* @param {string} sessionId Uniquely identifies this instance of the receiver application.
* @param {string} appId The identifer of the Cast application.
* @param {string} displayName The human-readable name of the Cast application, for example, "YouTube".
* @param {chrome.cast.Image[]} appImages Array of images available describing the application.
* @param {chrome.cast.Receiver} receiver The receiver that is running the application.
*
* @property {Object} customData Custom data set by the receiver application.
* @property {chrome.cast.media.Media} media The media that belong to this Cast session, including those loaded by other senders.
* @property {Object[]} namespaces A list of the namespaces supported by the receiver application.
* @property {chrome.cast.SenderApplication} senderApps The sender applications supported by the receiver application.
* @property {string} statusText Descriptive text for the current application content, for example “My Wedding Slideshow”.
*/
chrome.cast.Session = function Session (sessionId, appId, displayName, appImages, receiver) {
EventEmitter.call(this);
this.sessionId = sessionId;
this.appId = appId;
this.displayName = displayName;
this.appImages = appImages || [];
this.receiver = receiver;
this.media = [];
this.status = chrome.cast.SessionStatus.CONNECTED;
};
chrome.cast.Session.prototype = Object.create(EventEmitter.prototype);
function sessionPreCheck (sessionId) {
if (!_session || _session.status !== chrome.cast.SessionStatus.CONNECTED) {
return new chrome.cast.Error(
chrome.cast.ErrorCode.INVALID_PARAMETER, 'No active session');
}
if (sessionId !== _session.sessionId) {
return new chrome.cast.Error(
chrome.cast.ErrorCode.INVALID_PARAMETER, 'Unknown session ID');
}
}
chrome.cast.Session.prototype._preCheck = function (errorCallback) {
var err = sessionPreCheck(this.sessionId);
if (err) {
errorCallback && errorCallback(err);
return err;
}
};
/**
* Sets the receiver volume.
* @param {number} newLevel The new volume level between 0.0 and 1.0.
* @param {function} successCallback
* @param {function} errorCallback The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.setReceiverVolumeLevel = function (newLevel, successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
execute('setReceiverVolumeLevel', newLevel, function (err) {
if (!err) {
successCallback && successCallback();
} else {
handleError(err, errorCallback);
}
});
};
/**
* Sets the receiver volume.
* @param {boolean} muted The new muted status.
* @param {function} successCallback
* @param {function} errorCallback The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.setReceiverMuted = function (muted, successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
execute('setReceiverMuted', muted, function (err) {
if (!err) {
successCallback && successCallback();
} else {
handleError(err, errorCallback);
}
});
};
/**
* Stops the running receiver application associated with the session.
* @param {function} successCallback
* @param {function} errorCallback The possible errors are TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.stop = function (successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
execute('sessionStop', function (err) {
if (!err) {
successCallback && successCallback();
} else {
if (err === chrome.cast.ErrorCode.INVALID_PARAMETER) {
errorCallback(new chrome.cast.Error(chrome.cast.Error.INVALID_PARAMETER, 'No active session', null));
return;
}
handleError(err, errorCallback);
}
});
};
/**
* Leaves the current session.
* @param {function} successCallback
* @param {function} errorCallback The possible errors are TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.leave = function (successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
execute('sessionLeave', function (err) {
if (!err) {
successCallback && successCallback();
} else {
if (err === chrome.cast.ErrorCode.INVALID_PARAMETER) {
errorCallback(new chrome.cast.Error(chrome.cast.Error.INVALID_PARAMETER, 'No active session', null));
return;
}
handleError(err, errorCallback);
}
});
};
/**
* Sends a message to the receiver application on the given namespace.
* The successCallback is invoked when the message has been submitted to the messaging channel.
* Delivery to the receiver application is best effort and not guaranteed.
* @param {string} namespace
* @param {Object or string} message Must not be null
* @param {[type]} successCallback Invoked when the message has been sent. Must not be null.
* @param {[type]} errorCallback Invoked on error. The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, and EXTENSION_MISSING
*/
chrome.cast.Session.prototype.sendMessage = function (namespace, message, successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
if (typeof message === 'object') {
message = JSON.stringify(message);
}
execute('sendMessage', namespace, message, function (err) {
if (!err) {
successCallback && successCallback();
} else {
handleError(err, errorCallback);
}
});
};
/**
* Request to load media. Must not be null.
* @param {chrome.cast.media.LoadRequest} loadRequest Request to load media. Must not be null.
* @param {function} successCallback Invoked with the loaded Media on success.
* @param {function} errorCallback Invoked on error. The possible errors are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.loadMedia = function (loadRequest, successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
var self = this;
var mediaInfo = loadRequest.media;
execute('loadMedia', mediaInfo.contentId, mediaInfo.customData || {}, mediaInfo.contentType, mediaInfo.duration || 0.0, mediaInfo.streamType, loadRequest.autoplay || false, loadRequest.currentTime || 0, mediaInfo.metadata || {}, mediaInfo.textTrackSytle || {}, function (err, obj) {
if (!err) {
self._loadNewMedia(obj);
successCallback(self._getMedia());
// Also trigger the update notification
self._emitMediaUpdated(obj.playerState !== 'IDLE');
} else {
handleError(err, errorCallback);
}
});
};
/**
* Loads and optionally starts playback of a new queue of media items into a
* running receiver application.
* @param {chrome.cast.media.QueueLoadRequest} loadRequest - Request to load a
* new queue of media items. Value must not be null.
* @param {function} successCallback Invoked with the loaded Media on success.
* @param {function} errorCallback Invoked on error. The possible errors
* are TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR,
* SESSION_ERROR, and EXTENSION_MISSING.
*/
chrome.cast.Session.prototype.queueLoad = function (loadRequest, successCallback, errorCallback) {
if (this._preCheck(errorCallback)) { return; }
if (!loadRequest.items || loadRequest.items.length === 0) {
return errorCallback && errorCallback(new chrome.cast.Error(
chrome.cast.ErrorCode.SESSION_ERROR, 'INVALID_PARAMS',
{ reason: 'INVALID_PARAMS', type: 'INVALID_REQUEST' }));
}
var self = this;
execute('queueLoad', loadRequest, function (err, obj) {
if (!err) {
self._loadNewMedia(obj);
successCallback(self._getMedia());
// Also trigger the update notification
self._emitMediaUpdated(obj.playerState !== 'IDLE');
} else {
handleError(err, errorCallback);
}
});
};
/**
* Adds a listener that is invoked when the Session has changed.
* Changes to the following properties will trigger the listener:
* statusText, namespaces, status, and the volume of the receiver.
*
* Listeners should check the status property of the Session to
* determine its connection status. The boolean parameter isAlive is
* deprecated in favor of the status Session property. The isAlive
* parameter is still passed in for backwards compatibility, and is
* true unless status = chrome.cast.SessionStatus.STOPPED.
* @param {function} listener The listener to add.
*/
chrome.cast.Session.prototype.addUpdateListener = function (listener) {
this.on('_sessionUpdated', listener);
};
/**
* Removes a previously added listener for this Session.
* @param {function} listener The listener to remove.
*/
chrome.cast.Session.prototype.removeUpdateListener = function (listener) {
this.removeListener('_sessionUpdated', listener);
};
/**
* Adds a listener that is invoked when a message is received from the receiver application.
* The listener is invoked with the the namespace as the first argument and the message as the second argument.
* @param {string} namespace The namespace to listen on.
* @param {function} listener The listener to add.
*/
chrome.cast.Session.prototype.addMessageListener = function (namespace, listener) {
execute('addMessageListener', namespace);
this.on('message:' + namespace, listener);
};
/**
* Removes a previously added listener for messages.
* @param {string} namespace The namespace that is listened to.
* @param {function} listener The listener to remove.
*/
chrome.cast.Session.prototype.removeMessageListener = function (namespace, listener) {
this.removeListener('message:' + namespace, listener);
};
/**
* Adds a listener that is invoked when a media session is created by another sender.
* @param {function} listener The listener to add.
*/
chrome.cast.Session.prototype.addMediaListener = function (listener) {
this.on('_mediaListener', listener);
};
/**
* Removes a listener that was previously added with addMediaListener.
* @param {function} listener The listener to remove.
*/
chrome.cast.Session.prototype.removeMediaListener = function (listener) {
this.removeListener('_mediaListener', listener);
};
/**
* Updates the session with the new session information in obj.
*/
chrome.cast.Session.prototype._update = function (obj) {
var i;
for (var attr in obj) {
if (['receiver', 'media', 'appImages'].indexOf(attr) === -1) {
this[attr] = obj[attr];
}
}
if (obj.receiver) {
if (!this.receiver) {
this.receiver = new chrome.cast.Receiver();
}
this.receiver._update(obj.receiver);
} else {
this.receiver = null;
}
if (obj.media && obj.media.length > 0) {
this._updateMedia(obj.media[0]);
} else {
this._updateMedia(null);
}
// Empty appImages
this.appImages = this.appImages || [];
this.appImages.splice(0, this.appImages.length);
if (obj.appImages && obj.appImages.length > 0) {
// refill appImages
for (i = 0; i < obj.appImages.length; i++) {
this.appImages.push(new chrome.cast.Image(obj.appImages[i].url));
}
}
};
/**
* Updates the session's media array's 1st Media element with the
* new Media information in obj.
*/
chrome.cast.Session.prototype._updateMedia = function (obj) {
if (this.media && (!obj || JSON.stringify(obj) === '{}')) {
this.media.splice(0, _session.media.length);
return;
}
if (this.media.length === 0) {
// Create the base media object because one doesn't exist
this.media.push(new chrome.cast.media.Media(obj.sessionId, obj.mediaSessionId));
}
this._getMedia()._update(obj);
};
/**
* Empties the session's media array, and
* adds the new Media object described by media.
*/
chrome.cast.Session.prototype._loadNewMedia = function (media) {
// Remove previous media
this._updateMedia(null);
// Add the new media object
this._updateMedia(media);
};
chrome.cast.Session.prototype._emitMediaUpdated = function (isAlive) {
var media = this._getMedia();
if (media) {
media.emit('_mediaUpdated', isAlive);
}
};
chrome.cast.Session.prototype._emitMediaListener = function () {
if (this._getMedia()) {
this.emit('_mediaListener', this._getMedia());
}
};
chrome.cast.Session.prototype._getMedia = function () {
return this.media && this.media[0];
};
/**
* The volume of a device or media stream.
* @param {number} level The current volume level as a value between 0.0 and 1.0.
* @param {boolean} muted Whether the receiver is muted, independent of the volume level.
*/
chrome.cast.Volume = function (level, muted) {
this.level = level;
if (muted || muted === false) {
this.muted = !!muted;
}
};
chrome.cast.Volume.prototype._update = function (jsonObj) {
for (var attr in jsonObj) {
this[attr] = jsonObj[attr];
}
};
/**
* Describes the receiver running an application. Normally, these objects should not be created by the client.
* @param {string} label An identifier for the receiver that is unique to the browser profile and the origin of the API client.
* @param {string} friendlyName The user given name for the receiver.
* @param {chrome.cast.Capability[]} capabilities The capabilities of the receiver, for example audio and video.
* @param {chrome.cast.Volume} volume The current volume of the receiver.
*/
chrome.cast.Receiver = function (label, friendlyName, capabilities, volume) {
this.label = label;
this.friendlyName = friendlyName;
this.capabilities = capabilities || [];
this.volume = volume || null;
this.receiverType = chrome.cast.ReceiverType.CAST;
this.isActiveInput = null;
};
chrome.cast.Receiver.prototype._update = function (jsonObj) {
for (var attr in jsonObj) {
if (['volume'].indexOf(attr) === -1) {
this[attr] = jsonObj[attr];
}
}
if (jsonObj.volume) {
if (!this.volume) {
this.volume = new chrome.cast.Volume();
}
this.volume._update(jsonObj.volume);
}
};
/**
* Describes track metadata information
* @param {number} trackId Unique identifier of the track within the context of a chrome.cast.media.MediaInfo objects
* @param {chrome.cast.media.TrackType} trackType The type of track. Value must not be null.
*/
chrome.cast.media.Track = function Track (trackId, trackType) {
this.trackId = trackId;
this.type = trackType;
this.customData = this.language = this.name = this.subtype = this.trackContentId = this.trackContentType = null;
};
chrome.cast.media.Track.prototype._update = function (jsonObj) {
for (var attr in jsonObj) {
this[attr] = jsonObj[attr];
}
};
/**
* Describes a media item.
* @param {string} contentId Identifies the content.
* @param {string} contentType MIME content type of the media.
* @property {Object} customData Custom data set by the receiver application.
* @property {number} duration Duration of the content, in seconds.
* @property {any type} metadata Describes the media content.
* @property {chrome.cast.media.StreamType} streamType The type of media stream.
*/
chrome.cast.media.MediaInfo = function MediaInfo (contentId, contentType) {
this.contentId = contentId;
this.streamType = chrome.cast.media.StreamType.BUFFERED;
this.contentType = contentType;
this.customData = this.duration = this.metadata = null;