Interface: SourceService
LiveApiModel.SourceService
The Source Service operates on Collection Live Sources and Project Sources.
Methods
CreateSource
▸ CreateSource(request): Promise<CreateSourceResponse>
Create Collection Live Source
Create a new live source in a collection
Permissions
- scope:
SCOPE_VAPI_CREATE
Parameters
| Name | Type |
|---|---|
request | CreateSourceRequest |
Returns
Promise<CreateSourceResponse>
DeleteSource
▸ DeleteSource(request): Promise<DeleteSourceResponse>
Delete Live Source
Deletes a live source from a collection
Parameters
| Name | Type |
|---|---|
request | DeleteSourceRequest |
Returns
Promise<DeleteSourceResponse>
UpdateSource
▸ UpdateSource(request): Promise<UpdateSourceResponse>
Update Source
Update attributes of the Source.
Parameters
| Name | Type |
|---|---|
request | UpdateSourceRequest |
Returns
Promise<UpdateSourceResponse>
UpdateSourceInProject
▸ UpdateSourceInProject(request): Promise<UpdateSourceInProjectResponse>
Update Source
Update attributes of the Source.
Parameters
| Name | Type |
|---|---|
request | UpdateSourceInProjectRequest |
Returns
Promise<UpdateSourceInProjectResponse>
GetSource
▸ GetSource(request): Promise<GetSourceResponse>
Get Source
Get an existing source in a project
Parameters
| Name | Type |
|---|---|
request | GetSourceRequest |
Returns
Promise<GetSourceResponse>
GetSources
▸ GetSources(request): Promise<GetSourcesResponse>
Get Source
Get existing sources in a collection
Parameters
| Name | Type |
|---|---|
request | GetSourcesRequest |
Returns
Promise<GetSourcesResponse>
AddSourceToProject
▸ AddSourceToProject(request): Promise<AddSourceToProjectResponse>
Add Source to Project
Add a source to a project
Parameters
| Name | Type |
|---|---|
request | AddSourceToProjectRequest |
Returns
Promise<AddSourceToProjectResponse>
RemoveSourceFromProject
▸ RemoveSourceFromProject(request): Promise<RemoveSourceFromProjectResponse>
Delete Source From Project
Removes a source from a project.
Parameters
| Name | Type |
|---|---|
request | RemoveSourceFromProjectRequest |
Returns
Promise<RemoveSourceFromProjectResponse>