Options
All
  • Public
  • Public/Protected
  • All
Menu

Module components/environmentContext

Index

Type aliases

Variables

Functions

Type aliases

cameraSettingsType

cameraSettingsType: object

Type for one setting's description of a camera.

Type declaration

  • Forwarder: string
  • Id: string
  • Name: string

environmentArgs

environmentArgs: object

Type containing all the arguments needed to create a context containing the environment settings.

Type declaration

  • accessTokenUri: string
  • authorizationUri: string
  • bufferTime: number
  • cameras: cameraSettingsType[]
  • clientId: string
  • objectTypes: string[]
  • orchestratorObjectIdsUrl: string
  • orchestratorTimelinesUrl: string
  • orchestratorWebsocketUrl: string
  • redirectUri: string
  • segmentLength: number

Variables

Const environmentContext

environmentContext: Context<environmentArgs> = ...

The context which can be used by other components to get settings from the environment settings file.

Functions

EnvironmentProvider

  • EnvironmentProvider(props: object): Element

  • Context provider that reads settings file and serves results.

    Parameters

    • props: object
      • children: ReactNode

    Returns Element

Made by Horyus. Documentation generated by TypeDoc.