@byomakase/omakase-player 0.8.0 → 0.8.1

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.
@@ -209,4 +209,34 @@ export interface VideoApi extends Api {
209
209
  * Returns available HelpMenuGroup's
210
210
  */
211
211
  getHelpMenuGroups(): HelpMenuGroup[];
212
+ /**
213
+ * Adds safe zone area. Returns DOM <div> id.
214
+ * @param options
215
+ */
216
+ addSafeZone(options: {
217
+ topPercent: number;
218
+ bottomPercent: number;
219
+ leftPercent: number;
220
+ rightPercent: number;
221
+ htmlClass?: string;
222
+ }): string;
223
+ /**
224
+ * Adds safe zone calculated from provided aspect ratio expression
225
+ * @param options
226
+ */
227
+ addSafeZoneWithAspectRatio(options: {
228
+ aspectRatioText: string;
229
+ scalePercent?: number;
230
+ htmlClass?: string;
231
+ }): string;
232
+ /**
233
+ * Removes safe zone area by DOM <div> id
234
+ *
235
+ * @param id
236
+ */
237
+ removeSafeZone(id: string): any;
238
+ /**
239
+ * Clears all added safe zones
240
+ */
241
+ clearSafeZones(): any;
212
242
  }
@@ -35,6 +35,7 @@ export declare class DomController implements Destroyable {
35
35
  private divHelp;
36
36
  private divHelpMenu;
37
37
  private divErrorMessage;
38
+ private divSafeZoneWrapper;
38
39
  private _timeline;
39
40
  constructor(playerHTMLElementId: string);
40
41
  private createDom;
@@ -47,6 +48,20 @@ export declare class DomController implements Destroyable {
47
48
  private helpChangeHandler;
48
49
  isFullscreen(): boolean;
49
50
  toggleFullscreen(videoElement: HTMLVideoElement): void;
51
+ clearSafeZones(): void;
52
+ addSafeZone(options: {
53
+ topPercent: number;
54
+ bottomPercent: number;
55
+ leftPercent: number;
56
+ rightPercent: number;
57
+ htmlClass?: string;
58
+ }): string;
59
+ addSafeZoneWithAspectRatio(options: {
60
+ aspectRatioText: string;
61
+ scalePercent?: number;
62
+ htmlClass?: string;
63
+ }): string;
64
+ removeSafeZone(id: string): void;
50
65
  set videoController(value: VideoController);
51
66
  set timeline(value: Timeline);
52
67
  get videoElement(): HTMLVideoElement;