Documentation

Trailer extends Message
in package

Generated from protobuf message <code>livekit.DataStream.Trailer</code>

Table of Contents

Properties

$reason  : mixed
reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)
$stream_id  : mixed
unique identifier for this data stream
$attributes  : mixed
finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

Methods

__construct()  : mixed
Constructor.
getAttributes()  : MapField
finalizing updates for the stream, can also include additional insights for errors or endTime for transcription
getReason()  : string
reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)
getStreamId()  : string
unique identifier for this data stream
setAttributes()  : $this
finalizing updates for the stream, can also include additional insights for errors or endTime for transcription
setReason()  : $this
reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)
setStreamId()  : $this
unique identifier for this data stream

Properties

$reason

reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)

protected mixed $reason = ''

Generated from protobuf field string reason = 2;

$stream_id

unique identifier for this data stream

protected mixed $stream_id = ''

Generated from protobuf field string stream_id = 1;

$attributes

finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

private mixed $attributes

Generated from protobuf field map<string, string> attributes = 3;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $stream_id
      unique identifier for this data stream
@type string $reason
      reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)
@type array|\Google\Protobuf\Internal\MapField $attributes
      finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

}

getAttributes()

finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

public getAttributes() : MapField

Generated from protobuf field map<string, string> attributes = 3;

Return values
MapField

getReason()

reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)

public getReason() : string

Generated from protobuf field string reason = 2;

Return values
string

getStreamId()

unique identifier for this data stream

public getStreamId() : string

Generated from protobuf field string stream_id = 1;

Return values
string

setAttributes()

finalizing updates for the stream, can also include additional insights for errors or endTime for transcription

public setAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> attributes = 3;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setReason()

reason why the stream was closed (could contain "error" / "interrupted" / empty for expected end)

public setReason(string $var) : $this

Generated from protobuf field string reason = 2;

Parameters
$var : string
Return values
$this

setStreamId()

unique identifier for this data stream

public setStreamId(string $var) : $this

Generated from protobuf field string stream_id = 1;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results