PHP 8.4 library and CLI tools to read, modify, and generate ProPresenter 7 files: songs (.pro), playlists (.proplaylist), bundles (.probundle), themes, and the global library files (Macros, Labels, Groups, ClearGroups, CCLI, Messages, Timers, Stage, Workspace, Props, TestPatterns, Calendar, KeyMappings, CommunicationDevices). Built on the MIT-licensed ProPresenter7-Proto schema by greyshirtguy (v7.16.2). Includes 18 CLI parsers, comprehensive API docs in doc/, binary-format specs, and a synthetic 369-test PHPUnit suite covering RTF extraction, translation slides, ZIP64 repair, round-trip fidelity, and end-to-end generation.
317 lines
8.7 KiB
PHP
317 lines
8.7 KiB
PHP
<?php
|
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
# NO CHECKED-IN PROTOBUF GENCODE
|
|
# source: calendar.proto
|
|
|
|
namespace Rv\Data\CalendarDocument;
|
|
|
|
use Google\Protobuf\Internal\GPBType;
|
|
use Google\Protobuf\Internal\RepeatedField;
|
|
use Google\Protobuf\Internal\GPBUtil;
|
|
|
|
/**
|
|
* Generated from protobuf message <code>rv.data.CalendarDocument.Event</code>
|
|
*/
|
|
class Event extends \Google\Protobuf\Internal\Message
|
|
{
|
|
/**
|
|
* Stable identity of this calendar event.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
*/
|
|
protected $uuid = null;
|
|
/**
|
|
* Display name (e.g. "Doors Open").
|
|
*
|
|
* Generated from protobuf field <code>string name = 2;</code>
|
|
*/
|
|
protected $name = '';
|
|
/**
|
|
* When the event starts. Stored as Timestamp seconds (and optional nanos).
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp start_time = 4;</code>
|
|
*/
|
|
protected $start_time = null;
|
|
/**
|
|
* Opaque flags blob observed in samples. Often a single byte (e.g. 0x01)
|
|
* that ProPresenter uses for recurrence or visibility state.
|
|
*
|
|
* Generated from protobuf field <code>bytes flags = 5;</code>
|
|
*/
|
|
protected $flags = '';
|
|
/**
|
|
* When the event ends. Optional. Same format as `start_time`.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp end_time = 6;</code>
|
|
*/
|
|
protected $end_time = null;
|
|
/**
|
|
* Action that runs when the event fires. Encoded as raw protobuf bytes
|
|
* (a `rv.data.Action`-shaped message) so the schema can evolve without
|
|
* breaking existing clients.
|
|
*
|
|
* Generated from protobuf field <code>bytes action_data = 8;</code>
|
|
*/
|
|
protected $action_data = '';
|
|
/**
|
|
* Embedded copy of the macro definition the event triggers. Stored as
|
|
* raw protobuf bytes (shape compatible with `MacrosDocument.Macro`).
|
|
*
|
|
* Generated from protobuf field <code>bytes macro_data = 9;</code>
|
|
*/
|
|
protected $macro_data = '';
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array $data {
|
|
* Optional. Data for populating the Message object.
|
|
*
|
|
* @type \Rv\Data\UUID $uuid
|
|
* Stable identity of this calendar event.
|
|
* @type string $name
|
|
* Display name (e.g. "Doors Open").
|
|
* @type \Rv\Data\Timestamp $start_time
|
|
* When the event starts. Stored as Timestamp seconds (and optional nanos).
|
|
* @type string $flags
|
|
* Opaque flags blob observed in samples. Often a single byte (e.g. 0x01)
|
|
* that ProPresenter uses for recurrence or visibility state.
|
|
* @type \Rv\Data\Timestamp $end_time
|
|
* When the event ends. Optional. Same format as `start_time`.
|
|
* @type string $action_data
|
|
* Action that runs when the event fires. Encoded as raw protobuf bytes
|
|
* (a `rv.data.Action`-shaped message) so the schema can evolve without
|
|
* breaking existing clients.
|
|
* @type string $macro_data
|
|
* Embedded copy of the macro definition the event triggers. Stored as
|
|
* raw protobuf bytes (shape compatible with `MacrosDocument.Macro`).
|
|
* }
|
|
*/
|
|
public function __construct($data = NULL) {
|
|
\GPBMetadata\Calendar::initOnce();
|
|
parent::__construct($data);
|
|
}
|
|
|
|
/**
|
|
* Stable identity of this calendar event.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
* @return \Rv\Data\UUID|null
|
|
*/
|
|
public function getUuid()
|
|
{
|
|
return $this->uuid;
|
|
}
|
|
|
|
public function hasUuid()
|
|
{
|
|
return isset($this->uuid);
|
|
}
|
|
|
|
public function clearUuid()
|
|
{
|
|
unset($this->uuid);
|
|
}
|
|
|
|
/**
|
|
* Stable identity of this calendar event.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.UUID uuid = 1;</code>
|
|
* @param \Rv\Data\UUID $var
|
|
* @return $this
|
|
*/
|
|
public function setUuid($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\UUID::class);
|
|
$this->uuid = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Display name (e.g. "Doors Open").
|
|
*
|
|
* Generated from protobuf field <code>string name = 2;</code>
|
|
* @return string
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->name;
|
|
}
|
|
|
|
/**
|
|
* Display name (e.g. "Doors Open").
|
|
*
|
|
* Generated from protobuf field <code>string name = 2;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setName($var)
|
|
{
|
|
GPBUtil::checkString($var, True);
|
|
$this->name = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* When the event starts. Stored as Timestamp seconds (and optional nanos).
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp start_time = 4;</code>
|
|
* @return \Rv\Data\Timestamp|null
|
|
*/
|
|
public function getStartTime()
|
|
{
|
|
return $this->start_time;
|
|
}
|
|
|
|
public function hasStartTime()
|
|
{
|
|
return isset($this->start_time);
|
|
}
|
|
|
|
public function clearStartTime()
|
|
{
|
|
unset($this->start_time);
|
|
}
|
|
|
|
/**
|
|
* When the event starts. Stored as Timestamp seconds (and optional nanos).
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp start_time = 4;</code>
|
|
* @param \Rv\Data\Timestamp $var
|
|
* @return $this
|
|
*/
|
|
public function setStartTime($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\Timestamp::class);
|
|
$this->start_time = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Opaque flags blob observed in samples. Often a single byte (e.g. 0x01)
|
|
* that ProPresenter uses for recurrence or visibility state.
|
|
*
|
|
* Generated from protobuf field <code>bytes flags = 5;</code>
|
|
* @return string
|
|
*/
|
|
public function getFlags()
|
|
{
|
|
return $this->flags;
|
|
}
|
|
|
|
/**
|
|
* Opaque flags blob observed in samples. Often a single byte (e.g. 0x01)
|
|
* that ProPresenter uses for recurrence or visibility state.
|
|
*
|
|
* Generated from protobuf field <code>bytes flags = 5;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setFlags($var)
|
|
{
|
|
GPBUtil::checkString($var, False);
|
|
$this->flags = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* When the event ends. Optional. Same format as `start_time`.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp end_time = 6;</code>
|
|
* @return \Rv\Data\Timestamp|null
|
|
*/
|
|
public function getEndTime()
|
|
{
|
|
return $this->end_time;
|
|
}
|
|
|
|
public function hasEndTime()
|
|
{
|
|
return isset($this->end_time);
|
|
}
|
|
|
|
public function clearEndTime()
|
|
{
|
|
unset($this->end_time);
|
|
}
|
|
|
|
/**
|
|
* When the event ends. Optional. Same format as `start_time`.
|
|
*
|
|
* Generated from protobuf field <code>.rv.data.Timestamp end_time = 6;</code>
|
|
* @param \Rv\Data\Timestamp $var
|
|
* @return $this
|
|
*/
|
|
public function setEndTime($var)
|
|
{
|
|
GPBUtil::checkMessage($var, \Rv\Data\Timestamp::class);
|
|
$this->end_time = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Action that runs when the event fires. Encoded as raw protobuf bytes
|
|
* (a `rv.data.Action`-shaped message) so the schema can evolve without
|
|
* breaking existing clients.
|
|
*
|
|
* Generated from protobuf field <code>bytes action_data = 8;</code>
|
|
* @return string
|
|
*/
|
|
public function getActionData()
|
|
{
|
|
return $this->action_data;
|
|
}
|
|
|
|
/**
|
|
* Action that runs when the event fires. Encoded as raw protobuf bytes
|
|
* (a `rv.data.Action`-shaped message) so the schema can evolve without
|
|
* breaking existing clients.
|
|
*
|
|
* Generated from protobuf field <code>bytes action_data = 8;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setActionData($var)
|
|
{
|
|
GPBUtil::checkString($var, False);
|
|
$this->action_data = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Embedded copy of the macro definition the event triggers. Stored as
|
|
* raw protobuf bytes (shape compatible with `MacrosDocument.Macro`).
|
|
*
|
|
* Generated from protobuf field <code>bytes macro_data = 9;</code>
|
|
* @return string
|
|
*/
|
|
public function getMacroData()
|
|
{
|
|
return $this->macro_data;
|
|
}
|
|
|
|
/**
|
|
* Embedded copy of the macro definition the event triggers. Stored as
|
|
* raw protobuf bytes (shape compatible with `MacrosDocument.Macro`).
|
|
*
|
|
* Generated from protobuf field <code>bytes macro_data = 9;</code>
|
|
* @param string $var
|
|
* @return $this
|
|
*/
|
|
public function setMacroData($var)
|
|
{
|
|
GPBUtil::checkString($var, False);
|
|
$this->macro_data = $var;
|
|
|
|
return $this;
|
|
}
|
|
|
|
}
|
|
|