propresenter7-php-lib/proto/proApiV1Link.proto
Thorsten Buss 4d10db4f17 Initial public release
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.
2026-05-03 22:21:01 +02:00

119 lines
2.8 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 "rvtimestamp.proto";
import "uuid.proto";
message API_v1_GroupMember {
string ip = 1;
uint32 port = 2;
}
message API_v1_GroupMemberStatus {
enum API_v1_GroupMemberStatus_ConnectionStatus {
CONNECTION_STATUS_UNKNOWN = 0;
CONNECTION_STATUS_CONNECTED = 1;
CONNECTION_STATUS_DISCONNECTED = 2;
}
enum API_v1_GroupMemberStatus_Platform {
PLATFORM_UNKNOWN = 0;
PLATFORM_MACOS = 1;
PLATFORM_WIN32 = 2;
PLATFORM_WEB = 3;
}
string ip = 1;
uint32 port = 2;
string name = 3;
.rv.data.API_v1_GroupMemberStatus.API_v1_GroupMemberStatus_Platform platform = 4;
string os_version = 5;
string host_description = 6;
string api_version = 7;
.rv.data.API_v1_GroupMemberStatus.API_v1_GroupMemberStatus_ConnectionStatus connection_status = 8;
}
message API_v1_GroupDefinition {
.rv.data.Timestamp timestamp = 1;
string secret = 2;
string name = 3;
repeated .rv.data.API_v1_GroupMember members = 4;
.rv.data.UUID group_identifier = 5;
}
message API_v1_Link_Request {
message Heartbeat {
uint32 port = 1;
string if_modified_since = 2;
}
message Status {
}
message AddMember {
oneof AddType {
.rv.data.API_v1_GroupDefinition group_definition = 1;
.rv.data.API_v1_GroupMember member_details = 2;
}
}
message RemoveMember {
.rv.data.API_v1_GroupMember member_details = 1;
}
oneof Request {
.rv.data.API_v1_Link_Request.Heartbeat heartbeat = 1;
.rv.data.API_v1_Link_Request.Status status = 2;
.rv.data.API_v1_Link_Request.AddMember add_member = 3;
.rv.data.API_v1_Link_Request.RemoveMember remove_member = 4;
}
}
message API_v1_Link_Response {
message Heartbeat {
.rv.data.API_v1_GroupDefinition group_definition = 1;
.rv.data.API_v1_GroupMemberStatus status = 2;
}
message Status {
.rv.data.API_v1_GroupDefinition group_definition = 1;
string member_name = 2;
}
message AddMember {
message RemoteMachineAccepts {
}
message RemoteMachineDecline {
enum DeclineReason {
ALREADY_IN_GROUP = 0;
USER_DECLINED = 1;
}
.rv.data.API_v1_Link_Response.AddMember.RemoteMachineDecline.DeclineReason reason = 1;
}
oneof Result {
.rv.data.API_v1_GroupDefinition group_definition = 1;
.rv.data.API_v1_Link_Response.AddMember.RemoteMachineAccepts accept = 2;
.rv.data.API_v1_Link_Response.AddMember.RemoteMachineDecline decline = 3;
}
}
message RemoveMember {
}
oneof Response {
.rv.data.API_v1_Link_Response.Heartbeat heartbeat = 1;
.rv.data.API_v1_Link_Response.Status status = 2;
.rv.data.API_v1_Link_Response.AddMember add_member = 3;
.rv.data.API_v1_Link_Response.RemoveMember remove_member = 4;
}
}