VideoFlags interface

Video flags contain information about the available video actions and its dynamic properties based on the current video state.

Properties

canStream

Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.

hasData

Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.

isInUse

Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.

Property Details

canStream

Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.

canStream: boolean

Property Value

boolean

hasData

Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.

hasData: boolean

Property Value

boolean

isInUse

Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.

isInUse: boolean

Property Value

boolean