propresenter7-php-lib/proto/messages.proto
Thorsten Bus 8e80a8af88 Upgrade proto schema to ProPresenter Proto 19beta
Sync the bundled .proto definitions with greyshirtguy/ProPresenter7-Proto
"Proto 19beta" (dumped from ProPresenter v19 beta build 318767123,
2025-06-05). This pulls in the schema for ProPresenter 19 features
including new advertisement groups, custom options, media metadata,
prop API v1, transport API, feature flags, PSB workspace, and zone
definitions, plus refactored analytics tracked events.

Strategy: merge rather than wholesale replace. All Proto 19beta files
overwrite our existing copies so we pick up the field/message updates
upstream made between 7.16.2 and 19beta. Eleven new .proto files are
added: advertisementGroup, analyticsEdit, analyticsMediaManagement,
analyticsPowerPoint, analyticsTrackedEvents, analyticsTriggerCue,
customOptions, mediaMetadata, proCoreFeatureFlags, psbWorkspace, zone.
Three google/protobuf well-known types (any, source_context, type) are
added for completeness; only descriptor.proto is actually imported.

Five proto files are kept that are not part of Proto 19beta upstream:
calendar.proto and keyMappings.proto were extracted from PP binaries
to support our parse-calendar and parse-key-mappings tools, while
analyticsCapture/Update/WHMStore.proto are retained from the prior
7.16.2 set so existing generated descriptors keep loading.

generated/ is regenerated from scratch with `protoc --php_out=generated
--proto_path=proto *.proto` (protoc 29.3, google/protobuf PHP 4.33.5).
The full PHPUnit suite (369 tests, 1298 assertions) still passes
without any source changes - the new schema is wire-compatible with our
reference files and high-level wrappers.

Documentation references to "v7.16.2" are updated to "Proto 19beta" in
LICENSE, doc/formats/pp_song_spec.md, pp_playlist_spec.md,
pp_bundle_spec.md, and doc/internal/decisions.md.
2026-05-04 07:19:24 +02:00

85 lines
1.9 KiB
Protocol Buffer
Executable file

syntax = "proto3";
package rv.data;
option cc_enable_arenas = true;
option csharp_namespace = "Pro.SerializationInterop.RVProtoData";
option swift_prefix = "RVData_";
import "applicationInfo.proto";
import "customOptions.proto";
import "templateIdentification.proto";
import "timers.proto";
import "uuid.proto";
message Message {
reserved 5;
reserved 7;
reserved 8;
message Token {
message TokenTypeText {
string name = 1;
}
message TokenTypeTimer {
string name = 1;
.rv.data.UUID timer_uuid = 2;
}
message TokenTypeClock {
}
.rv.data.UUID uuid = 1;
oneof TokenType {
.rv.data.Message.Token.TokenTypeText text = 2;
.rv.data.Message.Token.TokenTypeTimer timer = 3;
.rv.data.Message.Token.TokenTypeClock clock = 4;
}
}
message TokenValue {
message TokenValueText {
string value = 1;
}
message TokenValueTimer {
.rv.data.Timer.Configuration configuration = 1;
.rv.data.Timer.Format format = 2;
}
message TokenValueClock {
.rv.data.Clock.Format format = 1;
}
.rv.data.UUID token_id = 1;
string token_name = 5;
oneof TokenValueType {
.rv.data.Message.TokenValue.TokenValueText text = 2;
.rv.data.Message.TokenValue.TokenValueTimer timer = 3;
.rv.data.Message.TokenValue.TokenValueClock clock = 4;
}
}
enum ClearType {
CLEAR_TYPE_MANUAL = 0;
CLEAR_TYPE_AFTER_TIME = 1;
CLEAR_TYPE_AFTER_TIMERS = 2;
}
.rv.data.UUID uuid = 1;
string title = 2;
double time_to_remove = 3;
bool visible_on_network = 4;
.rv.data.TemplateIdentification template = 6;
.rv.data.Message.ClearType clear_type = 9;
string message_text = 10;
repeated .rv.data.Message.Token tokens = 11;
repeated .rv.data.Message.TokenValue token_values = 12;
}
message MessageDocument {
.rv.data.ApplicationInfo application_info = 1;
repeated .rv.data.Message messages = 2;
}