Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Playbacks

Hierarchy

  • Playbacks

Index

Methods

Methods

control

  • control(params: { operation: string; playbackId: string }, callback: (err: Error) => void): void
  • control(params: { operation: string; playbackId: string }): Promise<void>
  • Control a playback.

    Parameters

    • params: { operation: string; playbackId: string }
      • operation: string

        Operation to perform on the playback.

      • playbackId: string

        Playbacks id.

    • callback: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Control a playback.

    Parameters

    • params: { operation: string; playbackId: string }
      • operation: string

        Operation to perform on the playback.

      • playbackId: string

        Playbacks id.

    Returns Promise<void>

get

  • get(params: { playbackId: string }, callback: (err: Error, playback: Playback) => void): void
  • get(params: { playbackId: string }): Promise<Playback>
  • Get a playbacks details.

    Parameters

    • params: { playbackId: string }
      • playbackId: string

        Playbacks id.

    • callback: (err: Error, playback: Playback) => void
        • (err: Error, playback: Playback): void
        • Parameters

          Returns void

    Returns void

  • Get a playbacks details.

    Parameters

    • params: { playbackId: string }
      • playbackId: string

        Playbacks id.

    Returns Promise<Playback>

stop

  • stop(params: { playbackId: string }, callback: (err: Error) => void): void
  • stop(params: { playbackId: string }): Promise<void>
  • Stop a playback.

    Parameters

    • params: { playbackId: string }
      • playbackId: string

        Playbacks id.

    • callback: (err: Error) => void
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Stop a playback.

    Parameters

    • params: { playbackId: string }
      • playbackId: string

        Playbacks id.

    Returns Promise<void>

Generated using TypeDoc