REST Resource: projects.locations.inputs

Stay organized with collections Save and categorize content based on your preferences.

Resource: Input

Input resource represents the endpoint from which the channel ingests the input stream.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "type": enum (Type),
  "tier": enum (Tier),
  "uri": string,
  "preprocessingConfig": {
    object (PreprocessingConfig)
  },
  "securityRules": {
    object (SecurityRule)
  },
  "inputStreamProperty": {
    object (InputStreamProperty)
  }
}
Fields
name

string

The resource name of the input, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

createTime

string (Timestamp format)

Output only. The creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

User-defined key/value metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

type

enum (Type)

Source type.

tier

enum (Tier)

Tier defines the maximum input specification that is accepted by the video pipeline. The billing is charged based on the tier specified here. See Pricing for more detail. The default is HD.

uri

string

Output only. URI to push the input stream to. Its format depends on the input type, for example:

  • RTMP_PUSH: rtmp://1.2.3.4/live/{STREAM-ID}
  • SRT_PUSH: srt://1.2.3.4:4201?streamid={STREAM-ID}
preprocessingConfig

object (PreprocessingConfig)

Preprocessing configurations.

securityRules

object (SecurityRule)

Security rule for access control.

inputStreamProperty

object (InputStreamProperty)

Output only. The information for the input stream. This field will be present only when this input receives the input stream.

Type

The type of the input.

Enums
TYPE_UNSPECIFIED Input type is not specified.
RTMP_PUSH Input will take an rtmp input stream.
SRT_PUSH Input will take an srt (Secure Reliable Transport) input stream.

Tier

Tier of the input specification.

Enums
TIER_UNSPECIFIED Tier is not specified.
SD Resolution < 1280x720. Bitrate <= 6 Mbps. FPS <= 60.
HD Resolution <= 1920x1080. Bitrate <= 25 Mbps. FPS <= 60.
UHD Resolution <= 4096x2160. Not supported yet.

PreprocessingConfig

Preprocessing configurations.

JSON representation
{
  "crop": {
    object (Crop)
  },
  "pad": {
    object (Pad)
  }
}
Fields
crop

object (Crop)

Specify the video cropping configuration.

pad

object (Pad)

Specify the video pad filter configuration.

Crop

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

JSON representation
{
  "topPixels": integer,
  "bottomPixels": integer,
  "leftPixels": integer,
  "rightPixels": integer
}
Fields
topPixels

integer

The number of pixels to crop from the top. The default is 0.

bottomPixels

integer

The number of pixels to crop from the bottom. The default is 0.

leftPixels

integer

The number of pixels to crop from the left. The default is 0.

rightPixels

integer

The number of pixels to crop from the right. The default is 0.

Pad

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

JSON representation
{
  "topPixels": integer,
  "bottomPixels": integer,
  "leftPixels": integer,
  "rightPixels": integer
}
Fields
topPixels

integer

The number of pixels to add to the top. The default is 0.

bottomPixels

integer

The number of pixels to add to the bottom. The default is 0.

leftPixels

integer

The number of pixels to add to the left. The default is 0.

rightPixels

integer

The number of pixels to add to the right. The default is 0.

SecurityRule

Security rules for access control. Each field represents one security rule. Only when the source of the input stream satisfies all the fields, this input stream can be accepted.

JSON representation
{
  "ipRanges": [
    string
  ]
}
Fields
ipRanges[]

string

At least one ip range must match unless none specified. The IP range is defined by CIDR block: for example, 192.0.1.0/24 for a range and 192.0.1.0/32 for a single IP address.

InputStreamProperty

Properties of the input stream.

JSON representation
{
  "lastEstablishTime": string,
  "videoStreams": [
    {
      object (VideoStreamProperty)
    }
  ],
  "audioStreams": [
    {
      object (AudioStreamProperty)
    }
  ]
}
Fields
lastEstablishTime

string (Timestamp format)

The time that the current input stream is accepted and the connection is established.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

videoStreams[]

object (VideoStreamProperty)

Properties of the video streams.

audioStreams[]

object (AudioStreamProperty)

Properties of the audio streams.

VideoStreamProperty

Properties of the video stream.

JSON representation
{
  "index": integer,
  "videoFormat": {
    object (VideoFormat)
  }
}
Fields
index

integer

Index of this video stream.

videoFormat

object (VideoFormat)

Properties of the video format.

VideoFormat

Properties of the video format.

JSON representation
{
  "codec": string,
  "widthPixels": integer,
  "heightPixels": integer,
  "frameRate": number
}
Fields
codec

string

Video codec used in this video stream.

widthPixels

integer

The width of the video stream in pixels.

heightPixels

integer

The height of the video stream in pixels.

frameRate

number

The frame rate of the input video stream.

AudioStreamProperty

Properties of the audio stream.

JSON representation
{
  "index": integer,
  "audioFormat": {
    object (AudioFormat)
  }
}
Fields
index

integer

Index of this audio stream.

audioFormat

object (AudioFormat)

Properties of the audio format.

AudioFormat

Properties of the audio format.

JSON representation
{
  "codec": string,
  "channelCount": integer,
  "channelLayout": [
    string
  ]
}
Fields
codec

string

Audio codec used in this audio stream.

channelCount

integer

The number of audio channels.

channelLayout[]

string

A list of channel names specifying the layout of the audio channels.

Methods

create

Creates an input with the provided unique ID in the specified region.

delete

Deletes the specified input.

get

Returns the specified input.

list

Returns a list of all inputs in the specified region.

patch

Updates the specified input.