GetLivePipelineResult

data class GetLivePipelineResult(val azureApiVersion: String, val bitrateKbps: Int, val description: String? = null, val id: String, val name: String, val parameters: List<ParameterDefinitionResponse>? = null, val state: String, val systemData: SystemDataResponse, val topologyName: String, val type: String)

Live pipeline represents a unique instance of a live topology, used for real-time ingestion, archiving and publishing of content for a unique RTSP camera.

Constructors

Link copied to clipboard
constructor(azureApiVersion: String, bitrateKbps: Int, description: String? = null, id: String, name: String, parameters: List<ParameterDefinitionResponse>? = null, state: String, systemData: SystemDataResponse, topologyName: String, type: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account.

Link copied to clipboard
val description: String? = null

An optional description for the pipeline.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Link copied to clipboard

The name of the resource

Link copied to clipboard

List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.

Link copied to clipboard

Current state of the pipeline (read-only).

Link copied to clipboard

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard

The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.

Link copied to clipboard

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"