@hussra/logos-proclaim 0.0.0-stage → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +48 -2
- package/dist/proclaim-api.d.ts +111 -0
- package/dist/proclaim-api.d.ts.map +1 -0
- package/dist/proclaim-api.js +574 -0
- package/dist/proclaim-api.js.map +1 -0
- package/dist/proclaim-status.d.ts +153 -0
- package/dist/proclaim-status.d.ts.map +1 -0
- package/dist/proclaim-status.js +313 -0
- package/dist/proclaim-status.js.map +1 -0
- package/dist/proclaim-types.d.ts +195 -0
- package/dist/proclaim-types.d.ts.map +1 -0
- package/dist/proclaim-types.js +105 -0
- package/dist/proclaim-types.js.map +1 -0
- package/package.json +50 -3
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import Emittery from 'emittery';
|
|
2
|
+
import { MediaState, QuickScreenKind, ServiceItemKind, ServicePart, type Presentation } from './proclaim-types.js';
|
|
3
|
+
export declare enum LogLevel {
|
|
4
|
+
DEBUG = 0,
|
|
5
|
+
INFO = 1,
|
|
6
|
+
WARN = 2,
|
|
7
|
+
ERROR = 3
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Event types for the ProclaimStatus object - emitted when the corresponding properties change
|
|
11
|
+
*/
|
|
12
|
+
export interface ProclaimStatusEvents {
|
|
13
|
+
onAir: boolean;
|
|
14
|
+
configured: boolean;
|
|
15
|
+
configValid: boolean;
|
|
16
|
+
connected: boolean;
|
|
17
|
+
appCommandAPIAuthenticated: boolean;
|
|
18
|
+
sessionId: string;
|
|
19
|
+
localWiFiAPIAuthenticated: boolean;
|
|
20
|
+
presentation: Presentation | null;
|
|
21
|
+
itemCount: number;
|
|
22
|
+
songCount: number;
|
|
23
|
+
presentationLocalRevision: number;
|
|
24
|
+
step: number;
|
|
25
|
+
itemId: string;
|
|
26
|
+
itemIndex: number;
|
|
27
|
+
itemTitle: string;
|
|
28
|
+
itemKind: ServiceItemKind | null;
|
|
29
|
+
itemSlideCount: number;
|
|
30
|
+
slideIndex: number;
|
|
31
|
+
quickScreenKind: QuickScreenKind;
|
|
32
|
+
mediaState: MediaState;
|
|
33
|
+
servicePart: ServicePart | null;
|
|
34
|
+
log: {
|
|
35
|
+
level: LogLevel;
|
|
36
|
+
message: string;
|
|
37
|
+
error?: Error;
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Status object for the Proclaim API. Holds the various status values, and emits
|
|
42
|
+
* events when their values change. No behaviour other than this.
|
|
43
|
+
*/
|
|
44
|
+
export declare class ProclaimStatus extends Emittery<ProclaimStatusEvents> {
|
|
45
|
+
#private;
|
|
46
|
+
constructor();
|
|
47
|
+
/**
|
|
48
|
+
* Is the ProclaimAPI object configured?
|
|
49
|
+
*/
|
|
50
|
+
get configured(): boolean;
|
|
51
|
+
set configured(value: boolean);
|
|
52
|
+
/**
|
|
53
|
+
* Is the ProclaimAPI object configuration valid?
|
|
54
|
+
*/
|
|
55
|
+
get configValid(): boolean;
|
|
56
|
+
set configValid(value: boolean);
|
|
57
|
+
/**
|
|
58
|
+
* Is the ProclaimAPI object connected to Proclaim (i.e. Proclaim is running and reachable)?
|
|
59
|
+
*/
|
|
60
|
+
get connected(): boolean;
|
|
61
|
+
set connected(value: boolean);
|
|
62
|
+
/**
|
|
63
|
+
* Is the ProclaimAPI object authenticated to the App Command API?
|
|
64
|
+
*/
|
|
65
|
+
get appCommandAPIAuthenticated(): boolean;
|
|
66
|
+
set appCommandAPIAuthenticated(value: boolean);
|
|
67
|
+
/**
|
|
68
|
+
* Is Proclaim on air?
|
|
69
|
+
*/
|
|
70
|
+
get onAir(): boolean;
|
|
71
|
+
set onAir(value: boolean);
|
|
72
|
+
/**
|
|
73
|
+
* The Proclaim on-air session ID
|
|
74
|
+
*/
|
|
75
|
+
get sessionId(): string;
|
|
76
|
+
set sessionId(value: string);
|
|
77
|
+
/**
|
|
78
|
+
* The auth token for the App Command API
|
|
79
|
+
*/
|
|
80
|
+
get appCommandAPIAuthToken(): string;
|
|
81
|
+
set appCommandAPIAuthToken(value: string);
|
|
82
|
+
get localWiFiAPIAuthenticated(): boolean;
|
|
83
|
+
set localWiFiAPIAuthenticated(value: boolean);
|
|
84
|
+
/**
|
|
85
|
+
* Connection ID for the local Wi-Fi API
|
|
86
|
+
*/
|
|
87
|
+
get localWiFiAPIConnectionId(): string;
|
|
88
|
+
set localWiFiAPIConnectionId(value: string);
|
|
89
|
+
/**
|
|
90
|
+
* Auth token for the local Wi-Fi API
|
|
91
|
+
*/
|
|
92
|
+
get localWifiAPIAuthToken(): string;
|
|
93
|
+
set localWifiAPIAuthToken(value: string);
|
|
94
|
+
/**
|
|
95
|
+
* The currently on-air presentation
|
|
96
|
+
*/
|
|
97
|
+
get presentation(): Presentation | null;
|
|
98
|
+
set presentation(value: Presentation | null);
|
|
99
|
+
/**
|
|
100
|
+
* The number of service items in the presentation
|
|
101
|
+
*/
|
|
102
|
+
get itemCount(): number;
|
|
103
|
+
set itemCount(value: number);
|
|
104
|
+
/**
|
|
105
|
+
* The number of song items in the presentation
|
|
106
|
+
*/
|
|
107
|
+
get songCount(): number;
|
|
108
|
+
set songCount(value: number);
|
|
109
|
+
/**
|
|
110
|
+
* The currently on-air presentation's local revison number - used to detect changes to the presentation while on air
|
|
111
|
+
*/
|
|
112
|
+
get presentationLocalRevision(): number;
|
|
113
|
+
set presentationLocalRevision(value: number);
|
|
114
|
+
/**
|
|
115
|
+
* The currently on-air presentation's "step" - increments with each change to a new slide
|
|
116
|
+
*/
|
|
117
|
+
get step(): number;
|
|
118
|
+
set step(value: number);
|
|
119
|
+
/**
|
|
120
|
+
* The ID of the currently showing service item
|
|
121
|
+
*/
|
|
122
|
+
get itemId(): string;
|
|
123
|
+
set itemId(value: string);
|
|
124
|
+
/**
|
|
125
|
+
* The index (within its service item) of the currently showing slide
|
|
126
|
+
*/
|
|
127
|
+
get slideIndex(): number;
|
|
128
|
+
set slideIndex(value: number);
|
|
129
|
+
get itemIndex(): number;
|
|
130
|
+
set itemIndex(value: number);
|
|
131
|
+
get itemTitle(): string;
|
|
132
|
+
set itemTitle(value: string);
|
|
133
|
+
get itemKind(): ServiceItemKind | null;
|
|
134
|
+
set itemKind(value: ServiceItemKind | null);
|
|
135
|
+
get itemSlideCount(): number;
|
|
136
|
+
set itemSlideCount(value: number);
|
|
137
|
+
/**
|
|
138
|
+
* The currently showing quick screen type
|
|
139
|
+
*/
|
|
140
|
+
get quickScreenKind(): QuickScreenKind;
|
|
141
|
+
set quickScreenKind(value: QuickScreenKind);
|
|
142
|
+
/**
|
|
143
|
+
* The current media state
|
|
144
|
+
*/
|
|
145
|
+
get mediaState(): MediaState;
|
|
146
|
+
set mediaState(value: MediaState);
|
|
147
|
+
/**
|
|
148
|
+
* Which part of the service we are in - pre-service, warm-up, service or post-service
|
|
149
|
+
*/
|
|
150
|
+
get servicePart(): ServicePart | null;
|
|
151
|
+
set servicePart(value: ServicePart | null);
|
|
152
|
+
}
|
|
153
|
+
//# sourceMappingURL=proclaim-status.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proclaim-status.d.ts","sourceRoot":"","sources":["../src/proclaim-status.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElH,oBAAY,QAAQ;IACnB,KAAK,IAAA;IACL,IAAI,IAAA;IACJ,IAAI,IAAA;IACJ,KAAK,IAAA;CACL;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,OAAO,CAAA;IAClB,0BAA0B,EAAE,OAAO,CAAA;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,yBAAyB,EAAE,OAAO,CAAA;IAClC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAA;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,yBAAyB,EAAE,MAAM,CAAA;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAA;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,eAAe,CAAA;IAChC,UAAU,EAAE,UAAU,CAAA;IACtB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;IAC/B,GAAG,EAAE;QAAE,KAAK,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,CAAA;CACxD;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,QAAQ,CAAC,oBAAoB,CAAC;;;IAiCjE;;OAEG;IACH,IAAI,UAAU,IAIQ,OAAO,CAF5B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAK5B;IAED;;OAEG;IACH,IAAI,WAAW,IAIQ,OAAO,CAF7B;IAED,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,EAK7B;IAED;;OAEG;IACH,IAAI,SAAS,IAIQ,OAAO,CAF3B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAK3B;IAED;;OAEG;IACH,IAAI,0BAA0B,IAIQ,OAAO,CAF5C;IAED,IAAI,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAK5C;IAED;;OAEG;IACH,IAAI,KAAK,IAIQ,OAAO,CAFvB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAKvB;IAED;;OAEG;IACH,IAAI,SAAS,IAIQ,MAAM,CAF1B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAK1B;IAED;;OAEG;IACH,IAAI,sBAAsB,IAIQ,MAAM,CAFvC;IAED,IAAI,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAIvC;IAED,IAAI,yBAAyB,IAIQ,OAAO,CAF3C;IAED,IAAI,yBAAyB,CAAC,KAAK,EAAE,OAAO,EAK3C;IAED;;OAEG;IACH,IAAI,wBAAwB,IAIQ,MAAM,CAFzC;IAED,IAAI,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAIzC;IAED;;OAEG;IACH,IAAI,qBAAqB,IAIQ,MAAM,CAFtC;IAED,IAAI,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAItC;IAED;;OAEG;IACH,IAAI,YAAY,IAIQ,YAAY,GAAG,IAAI,CAF1C;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,EAK1C;IAED;;OAEG;IACH,IAAI,SAAS,IAIQ,MAAM,CAF1B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAK1B;IAED;;OAEG;IACH,IAAI,SAAS,IAIQ,MAAM,CAF1B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAK1B;IAED;;OAEG;IACH,IAAI,yBAAyB,IAIQ,MAAM,CAF1C;IAED,IAAI,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAK1C;IAED;;OAEG;IACH,IAAI,IAAI,IAIQ,MAAM,CAFrB;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAKrB;IAED;;OAEG;IACH,IAAI,MAAM,IAIQ,MAAM,CAFvB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAKvB;IAED;;OAEG;IACH,IAAI,UAAU,IAIQ,MAAM,CAF3B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAK3B;IAED,IAAI,SAAS,IAIQ,MAAM,CAF1B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAK1B;IAED,IAAI,SAAS,IAIQ,MAAM,CAF1B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAK1B;IAED,IAAI,QAAQ,IAAI,eAAe,GAAG,IAAI,CAErC;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,EAKzC;IAED,IAAI,cAAc,IAIQ,MAAM,CAF/B;IAED,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAK/B;IAED;;OAEG;IACH,IAAI,eAAe,IAIQ,eAAe,CAFzC;IAED,IAAI,eAAe,CAAC,KAAK,EAAE,eAAe,EAKzC;IAED;;OAEG;IACH,IAAI,UAAU,IAIQ,UAAU,CAF/B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,UAAU,EAK/B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,IAAI,CAEpC;IAED,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,EAKxC;CACD"}
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
import Emittery from 'emittery';
|
|
2
|
+
import { MediaState, QuickScreenKind, ServiceItemKind, ServicePart } from './proclaim-types.js';
|
|
3
|
+
export var LogLevel;
|
|
4
|
+
(function (LogLevel) {
|
|
5
|
+
LogLevel[LogLevel["DEBUG"] = 0] = "DEBUG";
|
|
6
|
+
LogLevel[LogLevel["INFO"] = 1] = "INFO";
|
|
7
|
+
LogLevel[LogLevel["WARN"] = 2] = "WARN";
|
|
8
|
+
LogLevel[LogLevel["ERROR"] = 3] = "ERROR";
|
|
9
|
+
})(LogLevel || (LogLevel = {}));
|
|
10
|
+
/**
|
|
11
|
+
* Status object for the Proclaim API. Holds the various status values, and emits
|
|
12
|
+
* events when their values change. No behaviour other than this.
|
|
13
|
+
*/
|
|
14
|
+
export class ProclaimStatus extends Emittery {
|
|
15
|
+
#configured = false;
|
|
16
|
+
#configValid = false;
|
|
17
|
+
#connected = false;
|
|
18
|
+
#appCommandAPIAuthenticated = false;
|
|
19
|
+
#onAir = false;
|
|
20
|
+
#sessionId = '';
|
|
21
|
+
#appCommandAPIAuthToken = '';
|
|
22
|
+
#localWiFiAPIAuthenticated = false;
|
|
23
|
+
#localWiFiAPIConnectionId = '';
|
|
24
|
+
#localWiFiAPIAuthToken = '';
|
|
25
|
+
#presentation = null;
|
|
26
|
+
#itemCount = 0;
|
|
27
|
+
#songCount = 0;
|
|
28
|
+
#presentationLocalRevision = 0;
|
|
29
|
+
#step = 0;
|
|
30
|
+
#itemId = '';
|
|
31
|
+
#slideIndex = 0;
|
|
32
|
+
#itemIndex = -1;
|
|
33
|
+
#itemTitle = '';
|
|
34
|
+
#itemKind = null;
|
|
35
|
+
#itemSlideCount = 0;
|
|
36
|
+
#quickScreenKind = QuickScreenKind.None;
|
|
37
|
+
#mediaState = MediaState.Playing;
|
|
38
|
+
#servicePart = null;
|
|
39
|
+
constructor() {
|
|
40
|
+
super();
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Is the ProclaimAPI object configured?
|
|
44
|
+
*/
|
|
45
|
+
get configured() {
|
|
46
|
+
return this.#configured;
|
|
47
|
+
}
|
|
48
|
+
set configured(value) {
|
|
49
|
+
if (this.#configured !== value) {
|
|
50
|
+
this.#configured = value;
|
|
51
|
+
this.emit('configured', value);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Is the ProclaimAPI object configuration valid?
|
|
56
|
+
*/
|
|
57
|
+
get configValid() {
|
|
58
|
+
return this.#configValid;
|
|
59
|
+
}
|
|
60
|
+
set configValid(value) {
|
|
61
|
+
if (this.#configValid !== value) {
|
|
62
|
+
this.#configValid = value;
|
|
63
|
+
this.emit('configValid', value);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Is the ProclaimAPI object connected to Proclaim (i.e. Proclaim is running and reachable)?
|
|
68
|
+
*/
|
|
69
|
+
get connected() {
|
|
70
|
+
return this.#connected;
|
|
71
|
+
}
|
|
72
|
+
set connected(value) {
|
|
73
|
+
if (this.#connected !== value) {
|
|
74
|
+
this.#connected = value;
|
|
75
|
+
this.emit('connected', value);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Is the ProclaimAPI object authenticated to the App Command API?
|
|
80
|
+
*/
|
|
81
|
+
get appCommandAPIAuthenticated() {
|
|
82
|
+
return this.#appCommandAPIAuthenticated;
|
|
83
|
+
}
|
|
84
|
+
set appCommandAPIAuthenticated(value) {
|
|
85
|
+
if (this.#appCommandAPIAuthenticated !== value) {
|
|
86
|
+
this.#appCommandAPIAuthenticated = value;
|
|
87
|
+
this.emit('appCommandAPIAuthenticated', value);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Is Proclaim on air?
|
|
92
|
+
*/
|
|
93
|
+
get onAir() {
|
|
94
|
+
return this.#onAir;
|
|
95
|
+
}
|
|
96
|
+
set onAir(value) {
|
|
97
|
+
if (this.#onAir !== value) {
|
|
98
|
+
this.#onAir = value;
|
|
99
|
+
this.emit('onAir', value);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* The Proclaim on-air session ID
|
|
104
|
+
*/
|
|
105
|
+
get sessionId() {
|
|
106
|
+
return this.#sessionId;
|
|
107
|
+
}
|
|
108
|
+
set sessionId(value) {
|
|
109
|
+
if (this.#sessionId !== value) {
|
|
110
|
+
this.#sessionId = value;
|
|
111
|
+
this.emit('sessionId', value);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* The auth token for the App Command API
|
|
116
|
+
*/
|
|
117
|
+
get appCommandAPIAuthToken() {
|
|
118
|
+
return this.#appCommandAPIAuthToken;
|
|
119
|
+
}
|
|
120
|
+
set appCommandAPIAuthToken(value) {
|
|
121
|
+
if (this.#appCommandAPIAuthToken !== value) {
|
|
122
|
+
this.#appCommandAPIAuthToken = value;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
get localWiFiAPIAuthenticated() {
|
|
126
|
+
return this.#localWiFiAPIAuthenticated;
|
|
127
|
+
}
|
|
128
|
+
set localWiFiAPIAuthenticated(value) {
|
|
129
|
+
if (this.#localWiFiAPIAuthenticated !== value) {
|
|
130
|
+
this.#localWiFiAPIAuthenticated = value;
|
|
131
|
+
this.emit('localWiFiAPIAuthenticated', value);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Connection ID for the local Wi-Fi API
|
|
136
|
+
*/
|
|
137
|
+
get localWiFiAPIConnectionId() {
|
|
138
|
+
return this.#localWiFiAPIConnectionId;
|
|
139
|
+
}
|
|
140
|
+
set localWiFiAPIConnectionId(value) {
|
|
141
|
+
if (this.#localWiFiAPIConnectionId !== value) {
|
|
142
|
+
this.#localWiFiAPIConnectionId = value;
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Auth token for the local Wi-Fi API
|
|
147
|
+
*/
|
|
148
|
+
get localWifiAPIAuthToken() {
|
|
149
|
+
return this.#localWiFiAPIAuthToken;
|
|
150
|
+
}
|
|
151
|
+
set localWifiAPIAuthToken(value) {
|
|
152
|
+
if (this.#localWiFiAPIAuthToken !== value) {
|
|
153
|
+
this.#localWiFiAPIAuthToken = value;
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* The currently on-air presentation
|
|
158
|
+
*/
|
|
159
|
+
get presentation() {
|
|
160
|
+
return this.#presentation;
|
|
161
|
+
}
|
|
162
|
+
set presentation(value) {
|
|
163
|
+
if (this.#presentation !== value) {
|
|
164
|
+
this.#presentation = value;
|
|
165
|
+
this.emit('presentation', value);
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* The number of service items in the presentation
|
|
170
|
+
*/
|
|
171
|
+
get itemCount() {
|
|
172
|
+
return this.#itemCount;
|
|
173
|
+
}
|
|
174
|
+
set itemCount(value) {
|
|
175
|
+
if (this.#itemCount !== value) {
|
|
176
|
+
this.#itemCount = value;
|
|
177
|
+
this.emit('itemCount', value);
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* The number of song items in the presentation
|
|
182
|
+
*/
|
|
183
|
+
get songCount() {
|
|
184
|
+
return this.#songCount;
|
|
185
|
+
}
|
|
186
|
+
set songCount(value) {
|
|
187
|
+
if (this.#songCount !== value) {
|
|
188
|
+
this.#songCount = value;
|
|
189
|
+
this.emit('songCount', value);
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* The currently on-air presentation's local revison number - used to detect changes to the presentation while on air
|
|
194
|
+
*/
|
|
195
|
+
get presentationLocalRevision() {
|
|
196
|
+
return this.#presentationLocalRevision;
|
|
197
|
+
}
|
|
198
|
+
set presentationLocalRevision(value) {
|
|
199
|
+
if (this.#presentationLocalRevision !== value) {
|
|
200
|
+
this.#presentationLocalRevision = value;
|
|
201
|
+
this.emit('presentationLocalRevision', value);
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* The currently on-air presentation's "step" - increments with each change to a new slide
|
|
206
|
+
*/
|
|
207
|
+
get step() {
|
|
208
|
+
return this.#step;
|
|
209
|
+
}
|
|
210
|
+
set step(value) {
|
|
211
|
+
if (this.#step !== value) {
|
|
212
|
+
this.#step = value;
|
|
213
|
+
this.emit('step', value);
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* The ID of the currently showing service item
|
|
218
|
+
*/
|
|
219
|
+
get itemId() {
|
|
220
|
+
return this.#itemId;
|
|
221
|
+
}
|
|
222
|
+
set itemId(value) {
|
|
223
|
+
if (this.#itemId !== value) {
|
|
224
|
+
this.#itemId = value;
|
|
225
|
+
this.emit('itemId', value);
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* The index (within its service item) of the currently showing slide
|
|
230
|
+
*/
|
|
231
|
+
get slideIndex() {
|
|
232
|
+
return this.#slideIndex;
|
|
233
|
+
}
|
|
234
|
+
set slideIndex(value) {
|
|
235
|
+
if (this.#slideIndex !== value) {
|
|
236
|
+
this.#slideIndex = value;
|
|
237
|
+
this.emit('slideIndex', value);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
get itemIndex() {
|
|
241
|
+
return this.#itemIndex;
|
|
242
|
+
}
|
|
243
|
+
set itemIndex(value) {
|
|
244
|
+
if (this.#itemIndex !== value) {
|
|
245
|
+
this.#itemIndex = value;
|
|
246
|
+
this.emit('itemIndex', value);
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
get itemTitle() {
|
|
250
|
+
return this.#itemTitle;
|
|
251
|
+
}
|
|
252
|
+
set itemTitle(value) {
|
|
253
|
+
if (this.#itemTitle !== value) {
|
|
254
|
+
this.#itemTitle = value;
|
|
255
|
+
this.emit('itemTitle', value);
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
get itemKind() {
|
|
259
|
+
return this.#itemKind;
|
|
260
|
+
}
|
|
261
|
+
set itemKind(value) {
|
|
262
|
+
if (this.#itemKind !== value) {
|
|
263
|
+
this.#itemKind = value;
|
|
264
|
+
this.emit('itemKind', value);
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
get itemSlideCount() {
|
|
268
|
+
return this.#itemSlideCount;
|
|
269
|
+
}
|
|
270
|
+
set itemSlideCount(value) {
|
|
271
|
+
if (this.#itemSlideCount !== value) {
|
|
272
|
+
this.#itemSlideCount = value;
|
|
273
|
+
this.emit('itemSlideCount', value);
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* The currently showing quick screen type
|
|
278
|
+
*/
|
|
279
|
+
get quickScreenKind() {
|
|
280
|
+
return this.#quickScreenKind;
|
|
281
|
+
}
|
|
282
|
+
set quickScreenKind(value) {
|
|
283
|
+
if (this.#quickScreenKind !== value) {
|
|
284
|
+
this.#quickScreenKind = value;
|
|
285
|
+
this.emit('quickScreenKind', value);
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* The current media state
|
|
290
|
+
*/
|
|
291
|
+
get mediaState() {
|
|
292
|
+
return this.#mediaState;
|
|
293
|
+
}
|
|
294
|
+
set mediaState(value) {
|
|
295
|
+
if (this.#mediaState !== value) {
|
|
296
|
+
this.#mediaState = value;
|
|
297
|
+
this.emit('mediaState', value);
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Which part of the service we are in - pre-service, warm-up, service or post-service
|
|
302
|
+
*/
|
|
303
|
+
get servicePart() {
|
|
304
|
+
return this.#servicePart;
|
|
305
|
+
}
|
|
306
|
+
set servicePart(value) {
|
|
307
|
+
if (this.#servicePart !== value) {
|
|
308
|
+
this.#servicePart = value;
|
|
309
|
+
this.emit('servicePart', value);
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
//# sourceMappingURL=proclaim-status.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proclaim-status.js","sourceRoot":"","sources":["../src/proclaim-status.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,eAAe,EAAE,WAAW,EAAqB,MAAM,qBAAqB,CAAA;AAElH,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IACnB,yCAAK,CAAA;IACL,uCAAI,CAAA;IACJ,uCAAI,CAAA;IACJ,yCAAK,CAAA;AACN,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AA8BD;;;GAGG;AACH,MAAM,OAAO,cAAe,SAAQ,QAA8B;IACjE,WAAW,GAAG,KAAK,CAAA;IACnB,YAAY,GAAG,KAAK,CAAA;IACpB,UAAU,GAAG,KAAK,CAAA;IAClB,2BAA2B,GAAG,KAAK,CAAA;IACnC,MAAM,GAAG,KAAK,CAAA;IAEd,UAAU,GAAG,EAAE,CAAA;IACf,uBAAuB,GAAG,EAAE,CAAA;IAC5B,0BAA0B,GAAG,KAAK,CAAA;IAClC,yBAAyB,GAAG,EAAE,CAAA;IAC9B,sBAAsB,GAAG,EAAE,CAAA;IAE3B,aAAa,GAAwB,IAAI,CAAA;IACzC,UAAU,GAAG,CAAC,CAAA;IACd,UAAU,GAAG,CAAC,CAAA;IACd,0BAA0B,GAAG,CAAC,CAAA;IAC9B,KAAK,GAAG,CAAC,CAAA;IAET,OAAO,GAAG,EAAE,CAAA;IACZ,WAAW,GAAG,CAAC,CAAA;IACf,UAAU,GAAG,CAAC,CAAC,CAAA;IACf,UAAU,GAAG,EAAE,CAAA;IACf,SAAS,GAA2B,IAAI,CAAA;IACxC,eAAe,GAAG,CAAC,CAAA;IACnB,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAA;IACvC,WAAW,GAAG,UAAU,CAAC,OAAO,CAAA;IAChC,YAAY,GAAuB,IAAI,CAAA;IAEvC;QACC,KAAK,EAAE,CAAA;IACR,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,WAAW,CAAA;IACxB,CAAC;IAED,IAAI,UAAU,CAAC,KAAc;QAC5B,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;YACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QAC/B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,YAAY,CAAA;IACzB,CAAC;IAED,IAAI,WAAW,CAAC,KAAc;QAC7B,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;YACzB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QAChC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAc;QAC3B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,0BAA0B;QAC7B,OAAO,IAAI,CAAC,2BAA2B,CAAA;IACxC,CAAC;IAED,IAAI,0BAA0B,CAAC,KAAc;QAC5C,IAAI,IAAI,CAAC,2BAA2B,KAAK,KAAK,EAAE,CAAC;YAChD,IAAI,CAAC,2BAA2B,GAAG,KAAK,CAAA;YACxC,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;QAC/C,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAA;IACnB,CAAC;IAED,IAAI,KAAK,CAAC,KAAc;QACvB,IAAI,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QAC1B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,sBAAsB;QACzB,OAAO,IAAI,CAAC,uBAAuB,CAAA;IACpC,CAAC;IAED,IAAI,sBAAsB,CAAC,KAAa;QACvC,IAAI,IAAI,CAAC,uBAAuB,KAAK,KAAK,EAAE,CAAC;YAC5C,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAA;QACrC,CAAC;IACF,CAAC;IAED,IAAI,yBAAyB;QAC5B,OAAO,IAAI,CAAC,0BAA0B,CAAA;IACvC,CAAC;IAED,IAAI,yBAAyB,CAAC,KAAc;QAC3C,IAAI,IAAI,CAAC,0BAA0B,KAAK,KAAK,EAAE,CAAC;YAC/C,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAA;YACvC,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAA;QAC9C,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,wBAAwB;QAC3B,OAAO,IAAI,CAAC,yBAAyB,CAAA;IACtC,CAAC;IAED,IAAI,wBAAwB,CAAC,KAAa;QACzC,IAAI,IAAI,CAAC,yBAAyB,KAAK,KAAK,EAAE,CAAC;YAC9C,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAA;QACvC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,qBAAqB;QACxB,OAAO,IAAI,CAAC,sBAAsB,CAAA;IACnC,CAAC;IAED,IAAI,qBAAqB,CAAC,KAAa;QACtC,IAAI,IAAI,CAAC,sBAAsB,KAAK,KAAK,EAAE,CAAC;YAC3C,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAA;QACpC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAA;IAC1B,CAAC;IAED,IAAI,YAAY,CAAC,KAA0B;QAC1C,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QAC1B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QAC1B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,yBAAyB;QAC5B,OAAO,IAAI,CAAC,0BAA0B,CAAA;IACvC,CAAC;IAED,IAAI,yBAAyB,CAAC,KAAa;QAC1C,IAAI,IAAI,CAAC,0BAA0B,KAAK,KAAK,EAAE,CAAC;YAC/C,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAA;YACvC,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAA;QAC9C,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAA;IAClB,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACrB,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACzB,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAA;IACpB,CAAC;IAED,IAAI,MAAM,CAAC,KAAa;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;YACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QAC3B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,WAAW,CAAA;IACxB,CAAC;IAED,IAAI,UAAU,CAAC,KAAa;QAC3B,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;YACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QAC/B,CAAC;IACF,CAAC;IAED,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QAC1B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,IAAI,SAAS,CAAC,KAAa;QAC1B,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;IACF,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAA;IACtB,CAAC;IAED,IAAI,QAAQ,CAAC,KAA6B;QACzC,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;YACtB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QAC7B,CAAC;IACF,CAAC;IAED,IAAI,cAAc;QACjB,OAAO,IAAI,CAAC,eAAe,CAAA;IAC5B,CAAC;IAED,IAAI,cAAc,CAAC,KAAa;QAC/B,IAAI,IAAI,CAAC,eAAe,KAAK,KAAK,EAAE,CAAC;YACpC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;YAC5B,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC7B,CAAC;IAED,IAAI,eAAe,CAAC,KAAsB;QACzC,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAA;YAC7B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACb,OAAO,IAAI,CAAC,WAAW,CAAA;IACxB,CAAC;IAED,IAAI,UAAU,CAAC,KAAiB;QAC/B,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;YACxB,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QAC/B,CAAC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,YAAY,CAAA;IACzB,CAAC;IAED,IAAI,WAAW,CAAC,KAAyB;QACxC,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;YACzB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QAChC,CAAC;IACF,CAAC;CACD"}
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Proclaim app command API authentication response from /appCommand/authenticate
|
|
3
|
+
*/
|
|
4
|
+
export interface ProclaimAppCommandAPIAuthResponse {
|
|
5
|
+
proclaimAuthToken: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Proclaim Local Wi-Fi API authentication response from /auth/control
|
|
9
|
+
*/
|
|
10
|
+
export interface ProclaimLocalWiFiAPIAuthResponse {
|
|
11
|
+
authenticationToken: string;
|
|
12
|
+
connectionId: string;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Aspect ratio options
|
|
16
|
+
*/
|
|
17
|
+
export declare enum AspectRatio {
|
|
18
|
+
SixteenByNine = "SixteenByNine",
|
|
19
|
+
FourByThree = "FourByThree"
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* A Proclaim presentation - response from /presentations/onair endpoint
|
|
23
|
+
*/
|
|
24
|
+
export interface Presentation {
|
|
25
|
+
sessionId: string;
|
|
26
|
+
groupId: string;
|
|
27
|
+
groupName: string;
|
|
28
|
+
id: string;
|
|
29
|
+
localRevision: number;
|
|
30
|
+
title: string;
|
|
31
|
+
logoServiceItemId: string;
|
|
32
|
+
dateGiven: number;
|
|
33
|
+
startTime: number;
|
|
34
|
+
aspectRatio: AspectRatio;
|
|
35
|
+
warmupStartIndex: number;
|
|
36
|
+
serviceStartIndex: number;
|
|
37
|
+
postServiceStartIndex: number;
|
|
38
|
+
serviceItems: ServiceItem[];
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Types of service items - there will be more to follow, I am sure, but awaiting documentation
|
|
42
|
+
*/
|
|
43
|
+
export declare enum ServiceItemKind {
|
|
44
|
+
Announcement = "Announcement",
|
|
45
|
+
Content = "Content",
|
|
46
|
+
StageDirectionCue = "StageDirectionCue",
|
|
47
|
+
SongLyrics = "SongLyrics",
|
|
48
|
+
Grouping = "Grouping"
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* An item within a presentation
|
|
52
|
+
*/
|
|
53
|
+
export interface ServiceItem {
|
|
54
|
+
id: string;
|
|
55
|
+
title: string;
|
|
56
|
+
notes: string;
|
|
57
|
+
kind: ServiceItemKind;
|
|
58
|
+
slides: Slide[];
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* A slide within a service item
|
|
62
|
+
*/
|
|
63
|
+
export interface Slide {
|
|
64
|
+
localRevision: number;
|
|
65
|
+
index: number;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Proclaim on-air presentation status - response from /onair/statusChanged endpoint
|
|
69
|
+
*/
|
|
70
|
+
export interface PresentationStatus {
|
|
71
|
+
presentationId: string;
|
|
72
|
+
presentationLocalRevision: number;
|
|
73
|
+
status: {
|
|
74
|
+
revision: number;
|
|
75
|
+
itemId: string;
|
|
76
|
+
slideIndex: number;
|
|
77
|
+
quickScreenKind: QuickScreenKind;
|
|
78
|
+
mediaState: MediaState;
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Available Quick Screen types (at least, the ones that show up in PresentationStatus)
|
|
83
|
+
*/
|
|
84
|
+
export declare enum QuickScreenKind {
|
|
85
|
+
None = "None",
|
|
86
|
+
NoText = "NoText",
|
|
87
|
+
Logo = "Logo",
|
|
88
|
+
Blank = "Blank",
|
|
89
|
+
Custom = "Custom",
|
|
90
|
+
OnScreenBible = "OnScreenBible"
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Media States - there may be more to follow, but awaiting documentation
|
|
94
|
+
*/
|
|
95
|
+
export declare enum MediaState {
|
|
96
|
+
Playing = "Playing",
|
|
97
|
+
Stopped = ""
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Parts of the service
|
|
101
|
+
*/
|
|
102
|
+
export declare enum ServicePart {
|
|
103
|
+
PreService = "Pre Service",
|
|
104
|
+
Warmup = "Warm Up",
|
|
105
|
+
Service = "Service",
|
|
106
|
+
PostService = "Post Service"
|
|
107
|
+
}
|
|
108
|
+
export declare enum SimpleAppCommand {
|
|
109
|
+
NextSlide = "NextSlide",
|
|
110
|
+
PreviousSlide = "PreviousSlide",
|
|
111
|
+
NextServiceItem = "NextServiceItem",
|
|
112
|
+
PreviousServiceItem = "PreviousServiceItem",
|
|
113
|
+
StartPreService = "StartPreService",
|
|
114
|
+
StartWarmUp = "StartWarmUp",
|
|
115
|
+
StartService = "StartService",
|
|
116
|
+
StartPostService = "StartPostService",
|
|
117
|
+
NextAudioItem = "NextAudioItem",
|
|
118
|
+
PreviousAudioItem = "PreviousPreviousAudioItem",// sic
|
|
119
|
+
VideoRestart = "VideoRestart",
|
|
120
|
+
VideoRewind = "VideoRewind",
|
|
121
|
+
VideoFastForward = "VideoFastForward",
|
|
122
|
+
VideoPlay = "VideoPlay",
|
|
123
|
+
VideoPause = "VideoPause",
|
|
124
|
+
ShowBlankQuickScreen = "ShowBlankQuickScreen",
|
|
125
|
+
ShowLogoQuickScreen = "ShowLogoQuickScreen",
|
|
126
|
+
ShowNoTextQuickScreen = "ShowNoTextQuickScreen",
|
|
127
|
+
ShowFloatingHeartsQuickScreen = "ShowFloatingHeartsQuickScreen",
|
|
128
|
+
ShowFloatingAmensQuickScreen = "ShowFloatingAmensQuickScreen",
|
|
129
|
+
ShowAmenQuickScreen = "ShowAmenQuickScreen",
|
|
130
|
+
ShowHallelujahQuickScreen = "ShowHallelujahQuickScreen",
|
|
131
|
+
ShowPraiseTheLordQuickScreen = "ShowPraiseTheLordQuickScreen",
|
|
132
|
+
ShowHeIsRisenQuickScreen = "ShowHeIsRisenQuickScreen",
|
|
133
|
+
ShowHeIsRisenWhiteQuickScreen = "ShowHeIsRisenWhiteQuickScreen",
|
|
134
|
+
ShowText = "ShowText",
|
|
135
|
+
ShowLastSlide = "ShowLastSlide",
|
|
136
|
+
GoOnAir = "GoOnAir",
|
|
137
|
+
GoOffAir = "GoOffAir"
|
|
138
|
+
}
|
|
139
|
+
export declare enum IndexedAppCommand {
|
|
140
|
+
GoToSlide = "GoToSlide",
|
|
141
|
+
GoToServiceItem = "GoToServiceItem",
|
|
142
|
+
GoToSong = "GoToSong",
|
|
143
|
+
ShowCustomQuickScreen = "ShowCustomQuickScreen",
|
|
144
|
+
ShowSongLyricsVerseByIndex = "ShowSongLyricsVerseByIndex",
|
|
145
|
+
ShowSongLyricsBridgeByIndex = "ShowSongLyricsBridgeByIndex",
|
|
146
|
+
ShowSongLyricsChorusByIndex = "ShowSongLyricsChorusByIndex",
|
|
147
|
+
ShowSongLyricsPreChorusByIndex = "ShowSongLyricsPreChorusByIndex",
|
|
148
|
+
ShowSongLyricsEndingByIndex = "ShowSongLyricsEndingByIndex",
|
|
149
|
+
ShowSongLyricsInterludeByIndex = "ShowSongLyricsInterludeByIndex",
|
|
150
|
+
ShowSongLyricsTagByIndex = "ShowSongLyricsTagByIndex"
|
|
151
|
+
}
|
|
152
|
+
export declare const AppCommand: {
|
|
153
|
+
GoToSlide: IndexedAppCommand.GoToSlide;
|
|
154
|
+
GoToServiceItem: IndexedAppCommand.GoToServiceItem;
|
|
155
|
+
GoToSong: IndexedAppCommand.GoToSong;
|
|
156
|
+
ShowCustomQuickScreen: IndexedAppCommand.ShowCustomQuickScreen;
|
|
157
|
+
ShowSongLyricsVerseByIndex: IndexedAppCommand.ShowSongLyricsVerseByIndex;
|
|
158
|
+
ShowSongLyricsBridgeByIndex: IndexedAppCommand.ShowSongLyricsBridgeByIndex;
|
|
159
|
+
ShowSongLyricsChorusByIndex: IndexedAppCommand.ShowSongLyricsChorusByIndex;
|
|
160
|
+
ShowSongLyricsPreChorusByIndex: IndexedAppCommand.ShowSongLyricsPreChorusByIndex;
|
|
161
|
+
ShowSongLyricsEndingByIndex: IndexedAppCommand.ShowSongLyricsEndingByIndex;
|
|
162
|
+
ShowSongLyricsInterludeByIndex: IndexedAppCommand.ShowSongLyricsInterludeByIndex;
|
|
163
|
+
ShowSongLyricsTagByIndex: IndexedAppCommand.ShowSongLyricsTagByIndex;
|
|
164
|
+
NextSlide: SimpleAppCommand.NextSlide;
|
|
165
|
+
PreviousSlide: SimpleAppCommand.PreviousSlide;
|
|
166
|
+
NextServiceItem: SimpleAppCommand.NextServiceItem;
|
|
167
|
+
PreviousServiceItem: SimpleAppCommand.PreviousServiceItem;
|
|
168
|
+
StartPreService: SimpleAppCommand.StartPreService;
|
|
169
|
+
StartWarmUp: SimpleAppCommand.StartWarmUp;
|
|
170
|
+
StartService: SimpleAppCommand.StartService;
|
|
171
|
+
StartPostService: SimpleAppCommand.StartPostService;
|
|
172
|
+
NextAudioItem: SimpleAppCommand.NextAudioItem;
|
|
173
|
+
PreviousAudioItem: SimpleAppCommand.PreviousAudioItem;
|
|
174
|
+
VideoRestart: SimpleAppCommand.VideoRestart;
|
|
175
|
+
VideoRewind: SimpleAppCommand.VideoRewind;
|
|
176
|
+
VideoFastForward: SimpleAppCommand.VideoFastForward;
|
|
177
|
+
VideoPlay: SimpleAppCommand.VideoPlay;
|
|
178
|
+
VideoPause: SimpleAppCommand.VideoPause;
|
|
179
|
+
ShowBlankQuickScreen: SimpleAppCommand.ShowBlankQuickScreen;
|
|
180
|
+
ShowLogoQuickScreen: SimpleAppCommand.ShowLogoQuickScreen;
|
|
181
|
+
ShowNoTextQuickScreen: SimpleAppCommand.ShowNoTextQuickScreen;
|
|
182
|
+
ShowFloatingHeartsQuickScreen: SimpleAppCommand.ShowFloatingHeartsQuickScreen;
|
|
183
|
+
ShowFloatingAmensQuickScreen: SimpleAppCommand.ShowFloatingAmensQuickScreen;
|
|
184
|
+
ShowAmenQuickScreen: SimpleAppCommand.ShowAmenQuickScreen;
|
|
185
|
+
ShowHallelujahQuickScreen: SimpleAppCommand.ShowHallelujahQuickScreen;
|
|
186
|
+
ShowPraiseTheLordQuickScreen: SimpleAppCommand.ShowPraiseTheLordQuickScreen;
|
|
187
|
+
ShowHeIsRisenQuickScreen: SimpleAppCommand.ShowHeIsRisenQuickScreen;
|
|
188
|
+
ShowHeIsRisenWhiteQuickScreen: SimpleAppCommand.ShowHeIsRisenWhiteQuickScreen;
|
|
189
|
+
ShowText: SimpleAppCommand.ShowText;
|
|
190
|
+
ShowLastSlide: SimpleAppCommand.ShowLastSlide;
|
|
191
|
+
GoOnAir: SimpleAppCommand.GoOnAir;
|
|
192
|
+
GoOffAir: SimpleAppCommand.GoOffAir;
|
|
193
|
+
};
|
|
194
|
+
export type AppCommand = keyof typeof AppCommand;
|
|
195
|
+
//# sourceMappingURL=proclaim-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proclaim-types.d.ts","sourceRoot":"","sources":["../src/proclaim-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,iCAAiC;IACjD,iBAAiB,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAChD,mBAAmB,EAAE,MAAM,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,oBAAY,WAAW;IACtB,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,WAAW,CAAA;IACxB,gBAAgB,EAAE,MAAM,CAAA;IACxB,iBAAiB,EAAE,MAAM,CAAA;IACzB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,EAAE,WAAW,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,oBAAY,eAAe;IAC1B,YAAY,iBAAiB;IAC7B,OAAO,YAAY;IACnB,iBAAiB,sBAAsB;IACvC,UAAU,eAAe;IACzB,QAAQ,aAAa;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,eAAe,CAAA;IACrB,MAAM,EAAE,KAAK,EAAE,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,cAAc,EAAE,MAAM,CAAA;IACtB,yBAAyB,EAAE,MAAM,CAAA;IACjC,MAAM,EAAE;QACP,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,UAAU,EAAE,MAAM,CAAA;QAClB,eAAe,EAAE,eAAe,CAAA;QAChC,UAAU,EAAE,UAAU,CAAA;KACtB,CAAA;CACD;AAED;;GAEG;AACH,oBAAY,eAAe;IAC1B,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,aAAa,kBAAkB;CAC/B;AAED;;GAEG;AACH,oBAAY,UAAU;IACrB,OAAO,YAAY;IACnB,OAAO,KAAK;CACZ;AAED;;GAEG;AACH,oBAAY,WAAW;IACtB,UAAU,gBAAgB;IAC1B,MAAM,YAAY;IAClB,OAAO,YAAY;IACnB,WAAW,iBAAiB;CAC5B;AAED,oBAAY,gBAAgB;IAE3B,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,mBAAmB,wBAAwB;IAG3C,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IAGrC,aAAa,kBAAkB;IAC/B,iBAAiB,8BAA8B,CAAE,MAAM;IACvD,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,gBAAgB,qBAAqB;IACrC,SAAS,cAAc;IACvB,UAAU,eAAe;IAGzB,oBAAoB,yBAAyB;IAC7C,mBAAmB,wBAAwB;IAC3C,qBAAqB,0BAA0B;IAC/C,6BAA6B,kCAAkC;IAC/D,4BAA4B,iCAAiC;IAC7D,mBAAmB,wBAAwB;IAC3C,yBAAyB,8BAA8B;IACvD,4BAA4B,iCAAiC;IAC7D,wBAAwB,6BAA6B;IACrD,6BAA6B,kCAAkC;IAC/D,QAAQ,aAAa;IACrB,aAAa,kBAAkB;IAG/B,OAAO,YAAY;IACnB,QAAQ,aAAa;CACrB;AAED,oBAAY,iBAAiB;IAC5B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,QAAQ,aAAa;IACrB,qBAAqB,0BAA0B;IAC/C,0BAA0B,+BAA+B;IACzD,2BAA2B,gCAAgC;IAC3D,2BAA2B,gCAAgC;IAC3D,8BAA8B,mCAAmC;IACjE,2BAA2B,gCAAgC;IAC3D,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;CACrD;AAED,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGtB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,UAAU,CAAA"}
|