Class StreamService

Hierarchy

BaseService
- StreamService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StreamService(options: IRocosClientOptions): StreamService

Inherited from BaseService.constructor
- Defined in src/services/base-service.ts:9
Parameters
- options: IRocosClientOptions
Returns StreamService

Properties

Protected httpRequest

httpRequest: HttpRequest

Protected options

options: IRocosClientOptions

Methods

addData

addData(projectId: string, streamId: string, sources: StreamSource[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:73
Add new data to the stream

Parameters
- projectId: string
  
  Project Id
- streamId: string
  
  Stream Id
- sources: StreamSource[]
Returns Observable<RocosResponse<any>>

bindRobot

bindRobot(projId: string, streamId: string, callsigns: string[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:138
Bind robot with stream

Parameters
- projId: string
  
  Project Id
- streamId: string
  
  Steam Id
- callsigns: string[]
  
  The Robots' callsigns which should bind with stream
Returns Observable<RocosResponse<any>>

create

create(projId: string, stream: Stream): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:30
Create a new stream.

Parameters
- projId: string
  
  Project Id
- stream: Stream
  
  Stream object
Returns Observable<RocosResponse<any>>

dataExporterTemplates

dataExporterTemplates(): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:218
Get stream data exporter templates list

Returns Observable<RocosResponse<any>>

info

info(projectId: string, streamId: string): Observable<RocosResponse<Stream>>

- Defined in src/services/stream-service.ts:56
Get stream information by project id and stream id.

Parameters
- projectId: string
  
  Project Id
- streamId: string
  
  Stream Id
Returns Observable<RocosResponse<Stream>>

list

list(projId: string): Observable<RocosResponse<IStream[]>>

- Defined in src/services/stream-service.ts:43
Get streams list by project id.

Parameters
- projId: string
Returns Observable<RocosResponse<IStream[]>>

removeStreamData

removeStreamData(projId: string, streamId: string, dataIds: any[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:187
Remove stream data by dataIds list

Parameters
- projId: string
  
  Project Id
- streamId: string
  
  Stream Id
- dataIds: any[]
  
  Data Ids, e.g. {sourceId: string, dataId: string}
Returns Observable<RocosResponse<any>>

removeStreamDataByIds

removeStreamDataByIds(projId: string, streamId: string, ids: string[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:204
Remove stream data by ids list

Parameters
- projId: string
  
  Project Id
- streamId: string
  
  Stream Id
- ids: string[]
  
  ids list (string[])
Returns Observable<RocosResponse<any>>

removeStreams

removeStreams(projId: string, streamIds: string[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:171
Remove streams by list

Parameters
- projId: string
  
  Project Id
- streamIds: string[]
  
  Stream Ids
Returns Observable<RocosResponse<any>>

sourceInfo

sourceInfo(sourceId: string): Observable<RocosResponse<Source>>

- Defined in src/services/stream-service.ts:110
Get source info

Parameters
- sourceId: string
  
  Source Id
Returns Observable<RocosResponse<Source>>

sources

sources(): Observable<RocosResponse<Source[]>>

- Defined in src/services/stream-service.ts:100
Get sources for stream.

Returns Observable<RocosResponse<Source[]>>

streamsForRobot

streamsForRobot(projId: string, callsign: string): Observable<RocosResponse<IStream[]>>

- Defined in src/services/stream-service.ts:123
Get streams list of robot

Parameters
- projId: string
  
  Project Id
- callsign: string
  
  Robot's Callsign
Returns Observable<RocosResponse<IStream[]>>

unbindRobot

unbindRobot(projId: string, streamId: string, callsigns: string[]): Observable<RocosResponse<any>>

- Defined in src/services/stream-service.ts:155
Unbind robot with stream

Parameters
- projId: string
  
  Project Id
- streamId: string
  
  Steam Id
- callsigns: string[]
  
  The Robots' callsigns which should unbind with stream
Returns Observable<RocosResponse<any>>

Generated using TypeDoc