Variable stateConst

Type declaration

• acknowledgedVersion: RemovableRef<null | string>

  The previous acknowledged version.

  Remarks

  Used to let the user acknowledge (and internally handle) any new version

• compilation: RemovableRef<ICompilation>

  A compilation to work with

  Devdoc

  An initial, non-null value must be available, otherwise the reactive system does not work

  Devdoc

  To always provide a typed object as expected, explicitly serialize to and from JSON strings

• isPreRollEnabled: RemovableRef<boolean>

  The pre-roll enabled state.

  Remarks

  This can be set by the user, and is persisted.

• mediaUrls: Ref<Map<string, {
      mediaType: null | string;
      resourceName: string;
      size: null | number;
      source: string;
      url: string;
  }> & Omit<Map<string, MediaUrl>, keyof Map<any, any>>, Map<string, MediaUrl> | Map<string, {
      mediaType: null | string;
      resourceName: string;
      size: null | number;
      source: string;
      url: string;
  }> & Omit<Map<string, MediaUrl>, keyof Map<any, any>>>

  A dictionary of stored media URLs, representing playable media content from local or unzipped resources.

  Remarks

  A name for the resource is used as key, preventing duplicate files for the same content.

  Devdoc

  This is intentionally not persisted, to avoid using disposed object URL's after an app restart.

• playbackMode: RemovableRef<PlaybackMode>

  The current playback mode.

  Remarks

  This can be set by the user, and is persisted.

• scheduledCueId: RemovableRef<string>

  The currently scheduled cue Id, if any, otherwise CompilationHandler.EmptyId. This is NOT used to determine the currently active track.

  Remarks

  This does not control the playback itself. It is intended for display purposes. Set to CompilationHandler.EmptyId, when no cue should be considered scheduled.

  Devdoc

  An initial, non-null value must be available, otherwise the reactive system does not work

• selectedCueId: RemovableRef<string>

  The currently selected cue Id, if any, otherwise CompilationHandler.EmptyId. This is also used to determine the currently active track.

  Remarks

  This does not control the playback itself. It is intended for display purposes. Set to CompilationHandler.EmptyId, when no cue should be considered selected. To determine which track is active, when a cue is selected, it always takes precedence over a possibly selected track (selectedTrackId should be CompilationHandler.EmptyId in this case anyway). If no cue is selected, selectedTrackId is used to determine the active track.

  Devdoc

  An initial, non-null value must be available, otherwise the reactive system does not work

• selectedTrackId: RemovableRef<string>

  The currently selected track Id, if any, otherwise CompilationHandler.EmptyId. This is also used to determine the currently active track. This serves as alternative when no selected cue Id is set.

  Remarks

  This does not control the playback itself. It is intended for display purposes. Set to CompilationHandler.EmptyId, when no track should be considered selected.

  Devdoc

  An initial, non-null value must be available, otherwise the reactive system does not work

• shuffleSeed: number

  A seed for the deterministic shuffling (until next shuffling is requested)

  Remarks

  Reshuffling occurs when the PlaybackMode is toggled to ShuffleCompilation.

  Devdoc

  This allows to keep the shuffled order for the duration of the shuffle mode

• useAppShortcuts: Ref<boolean, boolean>

  Whether to use global app shortcuts

  Remarks

  This can be used to temporarily pause global app shortcuts in favor of use within modal or other dialogs.

  Devdoc

  This is intentionally not persisted, because it's temporay only.