Skip to main content

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​

NameType
requestCreateSourceRequest

Returns​

Promise<CreateSourceResponse>


DeleteSource​

▸ DeleteSource(request): Promise<DeleteSourceResponse>

Delete Live Source

Deletes a live source from a collection

Parameters​

NameType
requestDeleteSourceRequest

Returns​

Promise<DeleteSourceResponse>


UpdateSource​

▸ UpdateSource(request): Promise<UpdateSourceResponse>

Update Source

Update attributes of the Source.

Parameters​

NameType
requestUpdateSourceRequest

Returns​

Promise<UpdateSourceResponse>


UpdateSourceInProject​

▸ UpdateSourceInProject(request): Promise<UpdateSourceInProjectResponse>

Update Source

Update attributes of the Source.

Parameters​

NameType
requestUpdateSourceInProjectRequest

Returns​

Promise<UpdateSourceInProjectResponse>


GetSource​

▸ GetSource(request): Promise<GetSourceResponse>

Get Source

Get an existing source in a project

Parameters​

NameType
requestGetSourceRequest

Returns​

Promise<GetSourceResponse>


GetSources​

▸ GetSources(request): Promise<GetSourcesResponse>

Get Source

Get existing sources in a collection

Parameters​

NameType
requestGetSourcesRequest

Returns​

Promise<GetSourcesResponse>


AddSourceToProject​

▸ AddSourceToProject(request): Promise<AddSourceToProjectResponse>

Add Source to Project

Add a source to a project

Parameters​

NameType
requestAddSourceToProjectRequest

Returns​

Promise<AddSourceToProjectResponse>


RemoveSourceFromProject​

▸ RemoveSourceFromProject(request): Promise<RemoveSourceFromProjectResponse>

Delete Source From Project

Removes a source from a project.

Parameters​

NameType
requestRemoveSourceFromProjectRequest

Returns​

Promise<RemoveSourceFromProjectResponse>