Class SeamHttpMedia

constructor

• new SeamHttpMedia(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpMedia

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpMedia

client

Readonlydefaults

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>

get

• get(parameters: MediaGetParameters, options?: MediaGetOptions): MediaGetRequest

  Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in media_ids. This endpoint is in beta.

  Parameters

  • parameters: MediaGetParameters
  • options: MediaGetOptions = {}

  Returns MediaGetRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpMedia

StaticfromClient

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

  Parameters

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

  Returns SeamHttpMedia

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpMedia

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpMedia

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpMedia

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpMedia>