StreamConcurrencyService

public protocol StreamConcurrencyService

The Stream Concurrency Service contract

  • API to reserve a stream for playback. Returns error when the request fails. Whenever reserving a stream results in streams count reaching the allowed limit, the earlier allowed streams will be released automatically.

    Default Implementation

    API to reserve a stream for playback. Returns error when the request fails. Whenever reserving a stream results in streams count reaching the allowed limit, the earlier allowed streams will be released automatically.

    Declaration

    Swift

    func putStreamForDevice(deviceId: String, contentId: String?, primaryId: String?, catalogType: String?, token: String?, headers: Headers?, completion: @escaping (Result<Void, Error>) -> Void)

    Parameters

    deviceId

    The unique identifier of the device.
    contentId

    The content id for which the heartbeat is to be triggered
    primaryId

    The unique identifier of the primary content to which the selected content (i.e. secondary angle content) to play is associated with. This is applicable only for multi-camera enabled content.
    catalogType

    The value of the Catalog Type of content
    token

    The heartbeat token to be sent.
    headers

    Headers if any to be sent with request
    completion

    The handle to invoke on request completion

  • API to delete a stream for the given device Id. Returns error when the request fails.

    Default Implementation

    API to delete a stream for the given device Id. Returns error when the request fails.

    Declaration

    Swift

    func deleteStreamForDevice(deviceId: String, headers: Headers?, completion: @escaping (Result<Void, Error>) -> Void)