Documentation

TextHeader extends Message
in package

header properties specific to text streams

Generated from protobuf message livekit.DataStream.TextHeader

Table of Contents

Properties

$generated  : mixed
true if the text has been generated by an agent from a participant's audio transcription
$operation_type  : mixed
Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>
$reply_to_stream_id  : mixed
Optional: Reply to specific message
$version  : mixed
Optional: Version for updates/edits
$attached_stream_ids  : mixed
file attachments for text streams

Methods

__construct()  : mixed
Constructor.
getAttachedStreamIds()  : RepeatedField<string|int, string>
file attachments for text streams
getGenerated()  : bool
true if the text has been generated by an agent from a participant's audio transcription
getOperationType()  : int
Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>
getReplyToStreamId()  : string
Optional: Reply to specific message
getVersion()  : int
Optional: Version for updates/edits
setAttachedStreamIds()  : $this
file attachments for text streams
setGenerated()  : $this
true if the text has been generated by an agent from a participant's audio transcription
setOperationType()  : $this
Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>
setReplyToStreamId()  : $this
Optional: Reply to specific message
setVersion()  : $this
Optional: Version for updates/edits

Properties

$generated

true if the text has been generated by an agent from a participant's audio transcription

protected mixed $generated = false

Generated from protobuf field bool generated = 5;

$operation_type

Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>

protected mixed $operation_type = 0

$reply_to_stream_id

Optional: Reply to specific message

protected mixed $reply_to_stream_id = ''

Generated from protobuf field string reply_to_stream_id = 3;

$version

Optional: Version for updates/edits

protected mixed $version = 0

Generated from protobuf field int32 version = 2;

$attached_stream_ids

file attachments for text streams

private mixed $attached_stream_ids

Generated from protobuf field repeated string attached_stream_ids = 4;

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 int $operation_type
@type int $version
      Optional: Version for updates/edits
@type string $reply_to_stream_id
      Optional: Reply to specific message
@type string[] $attached_stream_ids
      file attachments for text streams
@type bool $generated
      true if the text has been generated by an agent from a participant's audio transcription

}

getAttachedStreamIds()

file attachments for text streams

public getAttachedStreamIds() : RepeatedField<string|int, string>

Generated from protobuf field repeated string attached_stream_ids = 4;

Return values
RepeatedField<string|int, string>

getGenerated()

true if the text has been generated by an agent from a participant's audio transcription

public getGenerated() : bool

Generated from protobuf field bool generated = 5;

Return values
bool

getOperationType()

Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>

public getOperationType() : int
Return values
int

getReplyToStreamId()

Optional: Reply to specific message

public getReplyToStreamId() : string

Generated from protobuf field string reply_to_stream_id = 3;

Return values
string

getVersion()

Optional: Version for updates/edits

public getVersion() : int

Generated from protobuf field int32 version = 2;

Return values
int

setAttachedStreamIds()

file attachments for text streams

public setAttachedStreamIds(array<string|int, string> $var) : $this

Generated from protobuf field repeated string attached_stream_ids = 4;

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

setGenerated()

true if the text has been generated by an agent from a participant's audio transcription

public setGenerated(bool $var) : $this

Generated from protobuf field bool generated = 5;

Parameters
$var : bool
Return values
$this

setOperationType()

Generated from protobuf field <code>.livekit.DataStream.OperationType operation_type = 1;</code>

public setOperationType(int $var) : $this
Parameters
$var : int
Return values
$this

setReplyToStreamId()

Optional: Reply to specific message

public setReplyToStreamId(string $var) : $this

Generated from protobuf field string reply_to_stream_id = 3;

Parameters
$var : string
Return values
$this

setVersion()

Optional: Version for updates/edits

public setVersion(int $var) : $this

Generated from protobuf field int32 version = 2;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results