Class SeamHttpCamerasLiveViews

constructor

• new SeamHttpCamerasLiveViews(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpCamerasLiveViews

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpCamerasLiveViews

client

Readonlydefaults

create

• create(
      parameters: CamerasLiveViewsCreateParameters,
      options?: CamerasLiveViewsCreateOptions,
  ): CamerasLiveViewsCreateRequest

  Creates a short-lived live view session for a single camera. Pass the returned session ID and token to /cameras/live_views/offer to start a WebRTC stream, and to /cameras/live_views/stop to end the session.

  Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use device.can_stream_live_video.

  Parameters

  • parameters: CamerasLiveViewsCreateParameters
  • options: CamerasLiveViewsCreateOptions = {}

  Returns CamerasLiveViewsCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamPaginatedRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamPaginatedRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

offer

• offer(
      parameters: CamerasLiveViewsOfferParameters,
      options?: CamerasLiveViewsOfferOptions,
  ): CamerasLiveViewsOfferRequest

  Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using /cameras/live_views/create.

  Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.

  Parameters

  • parameters: CamerasLiveViewsOfferParameters
  • options: CamerasLiveViewsOfferOptions = {}

  Returns CamerasLiveViewsOfferRequest

stop

• stop(
      parameters: CamerasLiveViewsStopParameters,
      options?: CamerasLiveViewsStopOptions,
  ): CamerasLiveViewsStopRequest

  Stops a camera live view session that the current client session owns.

  Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.

  Parameters

  • parameters: CamerasLiveViewsStopParameters
  • options: CamerasLiveViewsStopOptions = {}

  Returns CamerasLiveViewsStopRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpCamerasLiveViews

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpCamerasLiveViews

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpCamerasLiveViews

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpCamerasLiveViews

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpCamerasLiveViews

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpCamerasLiveViews

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpCamerasLiveViews

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpCamerasLiveViews

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpCamerasLiveViews

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpCamerasLiveViews

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpCamerasLiveViews>

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpCamerasLiveViews>