# StreamsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createStreamInput**](#createstreaminput) | **POST** /streams | Create a stream input|
|[**deleteStreamInput**](#deletestreaminput) | **DELETE** /streams/{streamId} | Delete a stream input|
|[**getStreamInput**](#getstreaminput) | **GET** /streams/{streamId} | Get a single stream input|
|[**getStreamInputs**](#getstreaminputs) | **GET** /streams | List an organization\'s stream inputs|
|[**getStreamVideos**](#getstreamvideos) | **GET** /streams/{streamId}/videos | List a stream\'s recorded videos|
|[**updateStream**](#updatestream) | **PUT** /streams/{streamId} | Update a stream input\'s settings|
|[**updateStreamInputConfig**](#updatestreaminputconfig) | **PUT** /streams/{streamId}/config | Update a stream input\'s recording configuration|

# **createStreamInput**
> CreateStreamInput200Response createStreamInput(streamInputCreateInputs)

Creates a new stream input record and a matching Cloudflare Stream live input configured for automatic recording, returning the input\'s connection details (RTMP/SRT/WebRTC URLs and keys); requires the read and create permissions on streams.

### Example

```typescript
import {
    StreamsApi,
    Configuration,
    StreamInputCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamInputCreateInputs: StreamInputCreateInputs; //

const { status, data } = await apiInstance.createStreamInput(
    streamInputCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamInputCreateInputs** | **StreamInputCreateInputs**|  | |


### Return type

**CreateStreamInput200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteStreamInput**
> CreateAccountInvitations200Response deleteStreamInput()

Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.

### Example

```typescript
import {
    StreamsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamId: string; //The stream identifier (default to undefined)

const { status, data } = await apiInstance.deleteStreamInput(
    streamId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamId** | [**string**] | The stream identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getStreamInput**
> CreateStreamInput200Response getStreamInput()

Returns details for a single stream input by ID, including its configuration for ingesting a live broadcast; requires read permission on streams.

### Example

```typescript
import {
    StreamsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamId: string; //The stream identifier (default to undefined)

const { status, data } = await apiInstance.getStreamInput(
    streamId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamId** | [**string**] | The stream identifier | defaults to undefined|


### Return type

**CreateStreamInput200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getStreamInputs**
> GetStreamInputs200Response getStreamInputs()

Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.

### Example

```typescript
import {
    StreamsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let eventId: string; //Filter by eventId (optional) (default to undefined)
let sessionId: string; //Filter by sessionId (optional) (default to undefined)
let groupId: string; //Filter by groupId (optional) (default to undefined)
let meetingId: string; //Filter by meetingId (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getStreamInputs(
    eventId,
    sessionId,
    groupId,
    meetingId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
| **meetingId** | [**string**] | Filter by meetingId | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetStreamInputs200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getStreamVideos**
> GetStreamVideos200Response getStreamVideos()

Returns a paginated list of recorded videos associated with the given stream, with optional search and ordering, and requires \"read\" permission on both streams and storage.

### Example

```typescript
import {
    StreamsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamId: string; //The stream identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getStreamVideos(
    streamId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamId** | [**string**] | The stream identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetStreamVideos200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateStream**
> CreateStreamInput200Response updateStream(streamInputUpdateInputs)

Updates the configurable fields (e.g. name, associated event/session/group, image) of an existing stream input (streamId); requires the read and update permissions on streams.

### Example

```typescript
import {
    StreamsApi,
    Configuration,
    StreamInputUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamId: string; //The stream identifier (default to undefined)
let streamInputUpdateInputs: StreamInputUpdateInputs; //

const { status, data } = await apiInstance.updateStream(
    streamId,
    streamInputUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamInputUpdateInputs** | **StreamInputUpdateInputs**|  | |
| **streamId** | [**string**] | The stream identifier | defaults to undefined|


### Return type

**CreateStreamInput200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateStreamInputConfig**
> CreateStreamInput200Response updateStreamInputConfig(streamInputUpdateInputs)

Updates Cloudflare recording settings (mode, signed URL requirement, recording retention days) for the given stream input (streamId); requires the update permission on streams. Note: the corresponding backend route has been removed, so this endpoint is currently non-functional.

### Example

```typescript
import {
    StreamsApi,
    Configuration,
    StreamInputUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new StreamsApi(configuration);

let streamId: string; //The stream identifier (default to undefined)
let streamInputUpdateInputs: StreamInputUpdateInputs; //

const { status, data } = await apiInstance.updateStreamInputConfig(
    streamId,
    streamInputUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **streamInputUpdateInputs** | **StreamInputUpdateInputs**|  | |
| **streamId** | [**string**] | The stream identifier | defaults to undefined|


### Return type

**CreateStreamInput200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)