GitHub
  • Preparing search index...
  • The search index is not available
@dolbyio/dolbyio-rest-apis-client - v5.1.0
  • @dolbyio/dolbyio-rest-apis-client
  • streaming
  • stream
  • stop

Function stop

  • stop(apiSecret, streamId): Promise<StreamStopResponse>
  • Stops an active stream.

    Parameters

    • apiSecret: string

      The API Secret used to authenticate this request.

    • streamId: string

      Identifier of the stream to stop.

    Returns Promise<StreamStopResponse>

    A Promise whose fulfillment handler receives a StreamStopResponse object.

    Link

    https://docs.dolby.io/streaming-apis/reference/stream_stopstream

    Note

    Prior to stopping the stream, you must call disable.

    • Defined in streaming/stream.ts:17

Settings

Member Visibility

Theme

@dolbyio/dolbyio-rest-apis-client - v5.1.0
  • Loading...

Generated using TypeDoc