Class StreamKeysApi

StreamKeysApi - object-oriented interface

export

Hierarchy

BaseAPI
- StreamKeysApi

Index

Constructors

constructor

Methods

Constructors

constructor

new StreamKeysApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): StreamKeysApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StreamKeysApi

Methods

createSceneStreamKey

createSceneStreamKey(requestParameters: StreamKeysApiCreateSceneStreamKeyRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<StreamKey, any>>

- Defined in api.ts:17917
Create a stream-key for a scene.

throws
{RequiredError}

memberof
StreamKeysApi

Parameters
- requestParameters: StreamKeysApiCreateSceneStreamKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<StreamKey, any>>

deleteStreamKey

deleteStreamKey(requestParameters: StreamKeysApiDeleteStreamKeyRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:17937
Delete a stream-key.

throws
{RequiredError}

memberof
StreamKeysApi

Parameters
- requestParameters: StreamKeysApiDeleteStreamKeyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>

getStreamKeys

getStreamKeys(requestParameters?: StreamKeysApiGetStreamKeysRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<StreamKeyList, any>>

- Defined in api.ts:17953
Get stream-keys.

throws
{RequiredError}

memberof
StreamKeysApi

Parameters
- requestParameters: StreamKeysApiGetStreamKeysRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<StreamKeyList, any>>