Class protos.google.cloud.video.livestream.v1.AudioStream (0.3.4)

Represents an AudioStream.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.video.livestream.v1.IAudioStream);

Constructs a new AudioStream.

Parameter

Name	Description
properties	`IAudioStream` Properties to set

Properties

bitrateBps

public bitrateBps: number;

AudioStream bitrateBps.

channelCount

public channelCount: number;

AudioStream channelCount.

channelLayout

public channelLayout: string[];

AudioStream channelLayout.

codec

public codec: string;

AudioStream codec.

mapping

public mapping: google.cloud.video.livestream.v1.AudioStream.IAudioMapping[];

AudioStream mapping.

sampleRateHertz

public sampleRateHertz: number;

AudioStream sampleRateHertz.

transmux

public transmux: boolean;

AudioStream transmux.

Methods

create(properties)

public static create(properties?: google.cloud.video.livestream.v1.IAudioStream): google.cloud.video.livestream.v1.AudioStream;

Creates a new AudioStream instance using the specified properties.

Parameter

Name	Description
properties	`IAudioStream` Properties to set

Returns

Type	Description
google.cloud.video.livestream.v1.AudioStream	AudioStream instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.livestream.v1.AudioStream;

Decodes an AudioStream message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.video.livestream.v1.AudioStream	AudioStream

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.livestream.v1.AudioStream;

Decodes an AudioStream message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.video.livestream.v1.AudioStream	AudioStream

encode(message, writer)

public static encode(message: google.cloud.video.livestream.v1.IAudioStream, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AudioStream message. Does not implicitly messages.

Parameters

Name	Description
message	`IAudioStream` AudioStream message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.video.livestream.v1.IAudioStream, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AudioStream message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IAudioStream` AudioStream message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.video.livestream.v1.AudioStream;

Creates an AudioStream message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.video.livestream.v1.AudioStream	AudioStream

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AudioStream

Parameter

Name	Description
typeUrlPrefix	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
string	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this AudioStream to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.video.livestream.v1.AudioStream, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an AudioStream message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.video.livestream.v1.AudioStream` AudioStream
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an AudioStream message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not