Documentation

TranscodingTask extends Message
in package

TranscodingTask will be the job for the transcoding worker.

Generated from protobuf message plugnmeet.TranscodingTask

Table of Contents

Properties

$file_name  : mixed
raw file name e.g. rec-xxx_raw.mp4
$file_path  : mixed
directory where raw file is stored
$recorder_id  : mixed
ID of the original recorder that captured the file
$recording_id  : mixed
Generated from protobuf field <code>string recording_id = 1;</code>
$recording_variant  : mixed
The variant of the recording
$room_id  : mixed
Generated from protobuf field <code>string room_id = 2;</code>
$room_sid  : mixed
Generated from protobuf field <code>string room_sid = 3;</code>
$room_table_id  : mixed
Generated from protobuf field <code>int64 room_table_id = 6;</code>

Methods

__construct()  : mixed
Constructor.
getFileName()  : string
raw file name e.g. rec-xxx_raw.mp4
getFilePath()  : string
directory where raw file is stored
getRecorderId()  : string
ID of the original recorder that captured the file
getRecordingId()  : string
Generated from protobuf field <code>string recording_id = 1;</code>
getRecordingVariant()  : int
The variant of the recording
getRoomId()  : string
Generated from protobuf field <code>string room_id = 2;</code>
getRoomSid()  : string
Generated from protobuf field <code>string room_sid = 3;</code>
getRoomTableId()  : int|string
Generated from protobuf field <code>int64 room_table_id = 6;</code>
setFileName()  : $this
raw file name e.g. rec-xxx_raw.mp4
setFilePath()  : $this
directory where raw file is stored
setRecorderId()  : $this
ID of the original recorder that captured the file
setRecordingId()  : $this
Generated from protobuf field <code>string recording_id = 1;</code>
setRecordingVariant()  : $this
The variant of the recording
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 2;</code>
setRoomSid()  : $this
Generated from protobuf field <code>string room_sid = 3;</code>
setRoomTableId()  : $this
Generated from protobuf field <code>int64 room_table_id = 6;</code>

Properties

$file_name

raw file name e.g. rec-xxx_raw.mp4

protected mixed $file_name = ''

Generated from protobuf field string file_name = 5;

$file_path

directory where raw file is stored

protected mixed $file_path = ''

Generated from protobuf field string file_path = 4;

$recorder_id

ID of the original recorder that captured the file

protected mixed $recorder_id = ''

Generated from protobuf field string recorder_id = 7;

$recording_id

Generated from protobuf field <code>string recording_id = 1;</code>

protected mixed $recording_id = ''

$recording_variant

The variant of the recording

protected mixed $recording_variant = 0

Generated from protobuf field .plugnmeet.CloudRecordingVariants recording_variant = 8;

$room_id

Generated from protobuf field <code>string room_id = 2;</code>

protected mixed $room_id = ''

$room_sid

Generated from protobuf field <code>string room_sid = 3;</code>

protected mixed $room_sid = ''

$room_table_id

Generated from protobuf field <code>int64 room_table_id = 6;</code>

protected mixed $room_table_id = 0

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 $recording_id
@type string $room_id
@type string $room_sid
@type string $file_path
      directory where raw file is stored
@type string $file_name
      raw file name e.g. rec-xxx_raw.mp4
@type int|string $room_table_id
@type string $recorder_id
      ID of the original recorder that captured the file
@type int $recording_variant
      The variant of the recording

}

getFileName()

raw file name e.g. rec-xxx_raw.mp4

public getFileName() : string

Generated from protobuf field string file_name = 5;

Return values
string

getFilePath()

directory where raw file is stored

public getFilePath() : string

Generated from protobuf field string file_path = 4;

Return values
string

getRecorderId()

ID of the original recorder that captured the file

public getRecorderId() : string

Generated from protobuf field string recorder_id = 7;

Return values
string

getRecordingId()

Generated from protobuf field <code>string recording_id = 1;</code>

public getRecordingId() : string
Return values
string

getRecordingVariant()

The variant of the recording

public getRecordingVariant() : int

Generated from protobuf field .plugnmeet.CloudRecordingVariants recording_variant = 8;

Return values
int

getRoomId()

Generated from protobuf field <code>string room_id = 2;</code>

public getRoomId() : string
Return values
string

getRoomSid()

Generated from protobuf field <code>string room_sid = 3;</code>

public getRoomSid() : string
Return values
string

getRoomTableId()

Generated from protobuf field <code>int64 room_table_id = 6;</code>

public getRoomTableId() : int|string
Return values
int|string

setFileName()

raw file name e.g. rec-xxx_raw.mp4

public setFileName(string $var) : $this

Generated from protobuf field string file_name = 5;

Parameters
$var : string
Return values
$this

setFilePath()

directory where raw file is stored

public setFilePath(string $var) : $this

Generated from protobuf field string file_path = 4;

Parameters
$var : string
Return values
$this

setRecorderId()

ID of the original recorder that captured the file

public setRecorderId(string $var) : $this

Generated from protobuf field string recorder_id = 7;

Parameters
$var : string
Return values
$this

setRecordingId()

Generated from protobuf field <code>string recording_id = 1;</code>

public setRecordingId(string $var) : $this
Parameters
$var : string
Return values
$this

setRecordingVariant()

The variant of the recording

public setRecordingVariant(int $var) : $this

Generated from protobuf field .plugnmeet.CloudRecordingVariants recording_variant = 8;

Parameters
$var : int
Return values
$this

setRoomId()

Generated from protobuf field <code>string room_id = 2;</code>

public setRoomId(string $var) : $this
Parameters
$var : string
Return values
$this

setRoomSid()

Generated from protobuf field <code>string room_sid = 3;</code>

public setRoomSid(string $var) : $this
Parameters
$var : string
Return values
$this

setRoomTableId()

Generated from protobuf field <code>int64 room_table_id = 6;</code>

public setRoomTableId(int|string $var) : $this
Parameters
$var : int|string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results