Rundown Server WebSocket API Reference

Request: Ping

Message Type: /Script/AvalancheMedia.AvaRundownPing

Request published by client to discover servers on the message bus. The available servers will respond with a Message: Pong.

Properties:

Json Format:

	{
		"bAuto": true,
		"requestedApiVersion": -1,
		"requestId": -1
	}
Copy full snippet

{ "bAuto": true, "requestedApiVersion": -1, "requestId": -1 }

Request: GetServerInfo

Message Type: /Script/AvalancheMedia.AvaRundownGetServerInfo

Requests the extended server information. Response is Message: ServerInfo.

Properties:

Json Format:

	{
		"requestId": -1
	}
Copy full snippet

{ "requestId": -1 }

Request: GetPlayableAssets

Message Type: /Script/AvalancheMedia.AvaRundownGetPlayableAssets

Requests a list of playable assets that can be added to a rundown template. Response is Message: PlayableAssets.

Properties:

Json Format:

	{
		"query": "",
		"limit": 0,
		"requestId": -1
	}
Copy full snippet

{ "query": "", "limit": 0, "requestId": -1 }

Request: GetRundowns

Message Type: /Script/AvalancheMedia.AvaRundownGetRundowns

Requests the list of rundowns that can be opened on the current server. Response is Message: Rundowns.

Properties:

Json Format:

	{
		"requestId": -1
	}
Copy full snippet

{ "requestId": -1 }

Request: LoadRundown

Message Type: /Script/AvalancheMedia.AvaRundownLoadRundown

Loads the given rundown for playback operations. This will also open an associated playback context. Only one rundown can be opened for playback at a time by the rundown server. If another rundown is opened, the previous one will be closed and all currently playing pages stopped, unless the rundown editor is opened. The rundown editor will keep the playback context alive.

If the path is empty, nothing will be done and the server will reply with a Message: ServerMsg message indicating which rundown is currently loaded.

Properties:

Json Format:

	{
		"rundown": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "requestId": -1 }

Request: CreateRundown

Message Type: /Script/AvalancheMedia.AvaRundownCreateRundown

Creates a new rundown asset.

The full package name is going to be: [PackagePath]/[AssetName] The full asset path is going to be: [PackagePath]/[AssetName].[AssetName] For all other requests, the rundown reference is the full asset path.

Response is Message: ServerMsg.

Properties:

Json Format:

	{
		"packagePath": "",
		"assetName": "",
		"bTransient": true,
		"requestId": -1
	}
Copy full snippet

{ "packagePath": "", "assetName": "", "bTransient": true, "requestId": -1 }

Request: DeleteRundown

Message Type: /Script/AvalancheMedia.AvaRundownDeleteRundown

Deletes an existing rundown.

Response is Message: ServerMsg.

Properties:

Json Format:

	{
		"rundown": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "requestId": -1 }

Request: ImportRundown

Message Type: /Script/AvalancheMedia.AvaRundownImportRundown

Imports rundown from json data or file.

Properties:

Json Format:

	{
		"rundown": "",
		"rundownFile": "",
		"rundownData": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "rundownFile": "", "rundownData": "", "requestId": -1 }

Request: ExportRundown

Message Type: /Script/AvalancheMedia.AvaRundownExportRundown

Exports a rundown to json data or file. This command is supported in game build.

Properties:

Json Format:

	{
		"rundown": "",
		"rundownFile": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "rundownFile": "", "requestId": -1 }

Request: SaveRundown

Message Type: /Script/AvalancheMedia.AvaRundownSaveRundown

Requests that the given rundown be saved to disk. The rundown asset must have been loaded, either by an edit command or playback, prior to this command. Unloaded assets will not be loaded by this command. This command is not supported in game builds.

Properties:

Json Format:

	{
		"rundown": "",
		"bOnlyIfIsDirty": false,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "bOnlyIfIsDirty": false, "requestId": -1 }

Request: CreatePage

Message Type: /Script/AvalancheMedia.AvaRundownCreatePage

Requests a new page be created from the specified template in the given rundown.

Properties:

Json Format:

	{
		"rundown": "",
		"idGeneratorParams":
		{
			"referenceId": -1,
			"increment": 1
		},
		"templateId": -1,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "idGeneratorParams": { "referenceId": -1, "increment": 1 }, "templateId": -1, "requestId": -1 }

Request: DeletePage

Message Type: /Script/AvalancheMedia.AvaRundownDeletePage

Requests the page be deleted from the given rundown.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "requestId": -1 }

Request: CreateTemplate

Message Type: /Script/AvalancheMedia.AvaRundownCreateTemplate

Requests the creation of a new template. If successful, the response is Message: ServerMsg with a "Template [Id] Created" text. The id of the created template can be parsed from that message's text. Also a secondary Message: PageListChanged event with added template id will be sent.

Properties:

Json Format:

	{
		"rundown": "",
		"idGeneratorParams":
		{
			"referenceId": -1,
			"increment": 1
		},
		"assetPath": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "idGeneratorParams": { "referenceId": -1, "increment": 1 }, "assetPath": "", "requestId": -1 }

Request: CreateComboTemplate

Message Type: /Script/AvalancheMedia.AvaRundownCreateComboTemplate

Requests the creation of a new combo template. If successful, the response is Message: ServerMsg with a "Template [Id] Created" text. The id of the created template can be parsed from that message's text. Also a secondary Message: PageListChanged event with added template id will be sent.

Remark: A combination template can only be created using transition logic templates that are in different transition layers.

Properties:

Json Format:

	{
		"rundown": "",
		"idGeneratorParams":
		{
			"referenceId": -1,
			"increment": 1
		},
		"combinedTemplateIds": [],
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "idGeneratorParams": { "referenceId": -1, "increment": 1 }, "combinedTemplateIds": [], "requestId": -1 }

Request: DeleteTemplate

Message Type: /Script/AvalancheMedia.AvaRundownDeleteTemplate

Requests deletion of the given template.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "requestId": -1 }

Request: ChangeTemplateBP

Message Type: /Script/AvalancheMedia.AvaRundownChangeTemplateBP

Sets the Page's template asset. This applies to template pages only.

Properties:

Json Format:

	{
		"rundown": "",
		"templateId": -1,
		"assetPath": "",
		"bReimport": false,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "templateId": -1, "assetPath": "", "bReimport": false, "requestId": -1 }

Request: GetPages

Message Type: /Script/AvalancheMedia.AvaRundownGetPages

Requests the list of pages from the given rundown.

Properties:

Json Format:

	{
		"rundown": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "requestId": -1 }

Request: GetPageDetails

Message Type: /Script/AvalancheMedia.AvaRundownGetPageDetails

Requests the page details from the given rundown. Response is Message: PageDetails.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"bLoadRemoteControlPreset": false,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "bLoadRemoteControlPreset": false, "requestId": -1 }

Request: PageChangeChannel

Message Type: /Script/AvalancheMedia.AvaRundownPageChangeChannel

Sets the channel of the given page. The page must be valid (and not a template) and the channel must exist in the current profile. Along with the corresponding response, this will also trigger a Message: PageChannelChanged event.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"channelName": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "channelName": "", "requestId": -1 }

Request: ChangePageName

Message Type: /Script/AvalancheMedia.AvaRundownChangePageName

Sets page name. Works for template or instance pages. By default, the command will set the page's "friendly" name as it is the one used for display purposes. The page name is reserved for native code uses. Along with the corresponding response, this will also trigger a Message: PageNameChanged event.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"pageName": "",
		"bSetFriendlyName": true,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "pageName": "", "bSetFriendlyName": true, "requestId": -1 }

Request: UpdatePageFromRCP

Message Type: /Script/AvalancheMedia.AvaRundownUpdatePageFromRCP

This is a request to save the managed Remote Control Preset (RCP) back to the corresponding page values.

Properties:

Json Format:

	{
		"bUnregister": false,
		"requestId": -1
	}
Copy full snippet

{ "bUnregister": false, "requestId": -1 }

Request: PageAction

Message Type: /Script/AvalancheMedia.AvaRundownPageAction

Request for a program page command on the current playback rundown.

Properties:

Json Format:

	{
		"pageId": -1,
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "pageId": -1, "action": "None", "requestId": -1 }

Request: PagePreviewAction

Message Type: /Script/AvalancheMedia.AvaRundownPagePreviewAction

Request for a preview page command on the current playback rundown.

Properties:

Json Format:

	{
		"previewChannelName": "",
		"pageId": -1,
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "previewChannelName": "", "pageId": -1, "action": "None", "requestId": -1 }

Request: PageActions

Message Type: /Script/AvalancheMedia.AvaRundownPageActions

Command to execute a program action on multiple pages at the same time. This is necessary for pages to be part of the same transition.

Properties:

Json Format:

	{
		"pageIds": [],
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "pageIds": [], "action": "None", "requestId": -1 }

Request: PagePreviewActions

Message Type: /Script/AvalancheMedia.AvaRundownPagePreviewActions

Command to execute a preview action on multiple pages at the same time. This is necessary for pages to be part of the same transition.

Properties:

Json Format:

	{
		"previewChannelName": "",
		"pageIds": [],
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "previewChannelName": "", "pageIds": [], "action": "None", "requestId": -1 }

Request: TransitionAction

Message Type: /Script/AvalancheMedia.AvaRundownTransitionAction

Command to override transition logic directly. As it currently stands, we can only have 1 transition per channel. If there is an issue with it, it may block further playback.

Properties:

Json Format:

	{
		"channelName": "",
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "action": "None", "requestId": -1 }

Request: TransitionLayerAction

Message Type: /Script/AvalancheMedia.AvaRundownTransitionLayerAction

Command to override transition logic.

Properties:

Json Format:

	{
		"channelName": "",
		"layerNames": [],
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "layerNames": [], "action": "None", "requestId": -1 }

Request: GetProfiles

Message Type: /Script/AvalancheMedia.AvaRundownGetProfiles

Requests a list of all profiles loaded for the current broadcast configuration. Response is Message: Profiles.

Properties:

Json Format:

	{
		"requestId": -1
	}
Copy full snippet

{ "requestId": -1 }

Request: DuplicateProfile

Message Type: /Script/AvalancheMedia.AvaRundownDuplicateProfile

Duplicates an existing profile. Fails if the new profile name already exist. Fails if the source profile does not exist.

Properties:

Json Format:

	{
		"sourceProfileName": "",
		"newProfileName": "",
		"bMakeCurrent": true,
		"requestId": -1
	}
Copy full snippet

{ "sourceProfileName": "", "newProfileName": "", "bMakeCurrent": true, "requestId": -1 }

Request: CreateProfile

Message Type: /Script/AvalancheMedia.AvaRundownCreateProfile

Creates a new empty profile with the given name. Fails if the profile already exist.

Properties:

Json Format:

	{
		"profileName": "",
		"bMakeCurrent": true,
		"requestId": -1
	}
Copy full snippet

{ "profileName": "", "bMakeCurrent": true, "requestId": -1 }

Request: RenameProfile

Message Type: /Script/AvalancheMedia.AvaRundownRenameProfile

Renames an existing profile.

Properties:

Json Format:

	{
		"oldProfileName": "",
		"newProfileName": "",
		"requestId": -1
	}
Copy full snippet

{ "oldProfileName": "", "newProfileName": "", "requestId": -1 }

Request: DeleteProfile

Message Type: /Script/AvalancheMedia.AvaRundownDeleteProfile

Deletes the specified profile. Fails if profile to be deleted is the current profile.

Properties:

Json Format:

	{
		"profileName": "",
		"requestId": -1
	}
Copy full snippet

{ "profileName": "", "requestId": -1 }

Request: SetCurrentProfile

Message Type: /Script/AvalancheMedia.AvaRundownSetCurrentProfile

Specified profile is made "current". The current profile becomes the context for all other broadcasts commands. Fails if some channels are currently broadcasting.

Properties:

Json Format:

	{
		"profileName": "",
		"requestId": -1
	}
Copy full snippet

{ "profileName": "", "requestId": -1 }

Request: GetChannel

Message Type: /Script/AvalancheMedia.AvaRundownGetChannel

Requests information (devices, status, etc) on a specified channel.

Response is Message: ChannelResponse.

Properties:

Json Format:

	{
		"channelName": "",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "requestId": -1 }

Request: GetChannels

Message Type: /Script/AvalancheMedia.AvaRundownGetChannels

Requests information (devices, status, etc) on all channels of the current profile.

Response is Message: Channels.

Properties:

Json Format:

	{
		"requestId": -1
	}
Copy full snippet

{ "requestId": -1 }

Request: ChannelAction

Message Type: /Script/AvalancheMedia.AvaRundownChannelAction

Requests a broadcast action on the specified channel(s).

Properties:

Json Format:

	{
		"channelName": "",
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "action": "None", "requestId": -1 }

Request: ChannelEditAction

Message Type: /Script/AvalancheMedia.AvaRundownChannelEditAction

Requests an edit action on the specified channel.

Properties:

Json Format:

	{
		"channelName": "",
		"action": "None",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "action": "None", "requestId": -1 }

Request: RenameChannel

Message Type: /Script/AvalancheMedia.AvaRundownRenameChannel

Requests a channel to be renamed.

Properties:

Json Format:

	{
		"oldChannelName": "",
		"newChannelName": "",
		"requestId": -1
	}
Copy full snippet

{ "oldChannelName": "", "newChannelName": "", "requestId": -1 }

Request: GetDevices

Message Type: /Script/AvalancheMedia.AvaRundownGetDevices

Requests a list of devices from the rundown server. The server will reply with Message: DevicesList containing the devices that can be enumerated from the local host and all connected hosts through the motion design playback service.

Properties:

Json Format:

	{
		"bShowAllMediaOutputClasses": false,
		"requestId": -1
	}
Copy full snippet

{ "bShowAllMediaOutputClasses": false, "requestId": -1 }

Request: AddChannelDevice

Message Type: /Script/AvalancheMedia.AvaRundownAddChannelDevice

Add an enumerated device to the given channel. This command will fail if the channel is live.

Properties:

Json Format:

	{
		"channelName": "",
		"mediaOutputName": "",
		"bSaveBroadcast": true,
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "mediaOutputName": "", "bSaveBroadcast": true, "requestId": -1 }

Request: EditChannelDevice

Message Type: /Script/AvalancheMedia.AvaRundownEditChannelDevice

Modify an existing device in the given channel. This command will fail if the channel is live.

Properties:

Json Format:

	{
		"channelName": "",
		"mediaOutputName": "",
		"data": "",
		"bSaveBroadcast": true,
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "mediaOutputName": "", "data": "", "bSaveBroadcast": true, "requestId": -1 }

Request: RemoveChannelDevice

Message Type: /Script/AvalancheMedia.AvaRundownRemoveChannelDevice

Remove an existing device from the given channel. This command will fail if the channel is live.

Properties:

Json Format:

	{
		"channelName": "",
		"mediaOutputName": "",
		"bSaveBroadcast": true,
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "mediaOutputName": "", "bSaveBroadcast": true, "requestId": -1 }

Request: GetChannelImage

Message Type: /Script/AvalancheMedia.AvaRundownGetChannelImage

Captures an image from the specified channel. The captured image is 25% of the channel's resolution. Intended for preview. Response is Message: ChannelImage.

Properties:

Json Format:

	{
		"channelName": "",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "requestId": -1 }

Request: GetChannelQualitySettings

Message Type: /Script/AvalancheMedia.AvaRundownGetChannelQualitySettings

Queries the given channel's quality settings. Response is Message: ChannelQualitySettings.

Properties:

Json Format:

	{
		"channelName": "",
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "requestId": -1 }

Request: SetChannelQualitySettings

Message Type: /Script/AvalancheMedia.AvaRundownSetChannelQualitySettings

Sets the given channel's quality settings.

Properties:

Json Format:

	{
		"channelName": "",
		"features": [],
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "features": [], "requestId": -1 }

Request: SaveBroadcast

Message Type: /Script/AvalancheMedia.AvaRundownSaveBroadcast

Save current broadcast configuration to a json file in the Config folder on the server.

Properties:

Json Format:

	{
		"requestId": -1
	}
Copy full snippet

{ "requestId": -1 }

Message: ServerMsg

Message Type: /Script/AvalancheMedia.AvaRundownServerMsg

This message is the default response message for all requests, unless a specific response message type is specified for the request. On success, the message will have a Verbosity of "Log" and the text may contain response payload related data. On failure, a message with Verbosity "Error" will be sent. This message's RequestId mirrors that of the corresponding request from the client.

Properties:

Json Format:

	{
		"verbosity": "",
		"text": "",
		"requestId": -1
	}
Copy full snippet

{ "verbosity": "", "text": "", "requestId": -1 }

Message: Pong

Message Type: /Script/AvalancheMedia.AvaRundownPong

The server will send this message to the client in response to Request: Ping. This is used to discover the server's entry point on the message bus.

Properties:

Json Format:

	{
		"bAuto": true,
		"apiVersion": -1,
		"minimumApiVersion": -1,
		"latestApiVersion": -1,
		"hostName": "",
		"requestId": -1
	}
Copy full snippet

{ "bAuto": true, "apiVersion": -1, "minimumApiVersion": -1, "latestApiVersion": -1, "hostName": "", "requestId": -1 }

Message: ServerInfo

Message Type: /Script/AvalancheMedia.AvaRundownServerInfo

Extended server information.

Properties:

Json Format:

	{
		"apiVersion": -1,
		"minimumApiVersion": -1,
		"latestApiVersion": -1,
		"hostName": "",
		"engineVersion": 0,
		"instanceId": "00000000000000000000000000000000",
		"instanceBuild": "Unknown",
		"instanceMode": "Unknown",
		"sessionId": "00000000000000000000000000000000",
		"projectName": "",
		"projectDir": "",
		"remoteControlHttpServerPort": 0,
		"remoteControlWebSocketServerPort": 0,
		"requestId": -1
	}
Copy full snippet

{ "apiVersion": -1, "minimumApiVersion": -1, "latestApiVersion": -1, "hostName": "", "engineVersion": 0, "instanceId": "00000000000000000000000000000000", "instanceBuild": "Unknown", "instanceMode": "Unknown", "sessionId": "00000000000000000000000000000000", "projectName": "", "projectDir": "", "remoteControlHttpServerPort": 0, "remoteControlWebSocketServerPort": 0, "requestId": -1 }

Message: PlayableAssets

Message Type: /Script/AvalancheMedia.AvaRundownPlayableAssets

List of all available playable assets on the server. Expected Response from Request: GetPlayableAssets.

Properties:

Json Format:

	{
		"assets": [],
		"requestId": -1
	}
Copy full snippet

{ "assets": [], "requestId": -1 }

Message: Rundowns

Message Type: /Script/AvalancheMedia.AvaRundownRundowns

List of all rundowns. Expected Response from Request: GetRundowns.

Properties:

Json Format:

	{
		"rundowns": [],
		"requestId": -1
	}
Copy full snippet

{ "rundowns": [], "requestId": -1 }

Message: ExportedRundown

Message Type: /Script/AvalancheMedia.AvaRundownExportedRundown

Server reply to Request: ExportRundown containing the exported rundown.

Properties:

Json Format:

	{
		"rundown": "",
		"rundownData": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "rundownData": "", "requestId": -1 }

Message: PlaybackContextChanged

Message Type: /Script/AvalancheMedia.AvaRundownPlaybackContextChanged

Rundown specific events broadcast by the server to help status display or related contexts in control applications.

Properties:

Json Format:

	{
		"previousRundown": "",
		"newRundown": "",
		"requestId": -1
	}
Copy full snippet

{ "previousRundown": "", "newRundown": "", "requestId": -1 }

Message: Pages

Message Type: /Script/AvalancheMedia.AvaRundownPages

• List of pages from the current rundown.

Properties:

Json Format:

	{
		"pages": [],
		"requestId": -1
	}
Copy full snippet

{ "pages": [], "requestId": -1 }

Message: PageDetails

Message Type: /Script/AvalancheMedia.AvaRundownPageDetails

Server response to Request: GetPageDetails request.

Properties:

Json Format:

	{
		"rundown": "",
		"pageInfo":
		{
			"pageId": -1,
			"pageName": "",
			"pageSummary": "",
			"friendlyName": "",
			"isTemplate": false,
			"templateId": -1,
			"combinedTemplateIds": [],
			"assetPath": "None",
			"statuses": [],
			"transitionLayerName": "",
			"bTransitionLogicEnabled": false,
			"commands": [],
			"outputChannel": "",
			"bIsEnabled": false,
			"bIsPlaying": false
		},
		"remoteControlValues":
		{
			"entityValues":
			{
			},
			"controllerValues":
			{
			}
		},
		"remoteControlPresetName": "",
		"remoteControlPresetId": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageInfo": { "pageId": -1, "pageName": "", "pageSummary": "", "friendlyName": "", "isTemplate": false, "templateId": -1, "combinedTemplateIds": [], "assetPath": "None", "statuses": [], "transitionLayerName": "", "bTransitionLogicEnabled": false, "commands": [], "outputChannel": "", "bIsEnabled": false, "bIsPlaying": false }, "remoteControlValues": { "entityValues": { }, "controllerValues": { } }, "remoteControlPresetName": "", "remoteControlPresetId": "", "requestId": -1 }

Message: PagesStatuses

Message Type: /Script/AvalancheMedia.AvaRundownPagesStatuses

Event sent when a page status changes.

Properties:

Json Format:

	{
		"rundown": "",
		"pageInfo":
		{
			"pageId": -1,
			"pageName": "",
			"pageSummary": "",
			"friendlyName": "",
			"isTemplate": false,
			"templateId": -1,
			"combinedTemplateIds": [],
			"assetPath": "None",
			"statuses": [],
			"transitionLayerName": "",
			"bTransitionLogicEnabled": false,
			"commands": [],
			"outputChannel": "",
			"bIsEnabled": false,
			"bIsPlaying": false
		},
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageInfo": { "pageId": -1, "pageName": "", "pageSummary": "", "friendlyName": "", "isTemplate": false, "templateId": -1, "combinedTemplateIds": [], "assetPath": "None", "statuses": [], "transitionLayerName": "", "bTransitionLogicEnabled": false, "commands": [], "outputChannel": "", "bIsEnabled": false, "bIsPlaying": false }, "requestId": -1 }

Message: PageListChanged

Message Type: /Script/AvalancheMedia.AvaRundownPageListChanged

Event sent when a page list (can be templates, pages or page views) has been modified.

Properties:

Json Format:

	{
		"rundown": "",
		"listType": "Instance",
		"subListId": "00000000000000000000000000000000",
		"changeType": 0,
		"affectedPages": [],
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "listType": "Instance", "subListId": "00000000000000000000000000000000", "changeType": 0, "affectedPages": [], "requestId": -1 }

Message: PageBlueprintChanged

Message Type: /Script/AvalancheMedia.AvaRundownPageBlueprintChanged

Event sent when a page's asset is modified. Note: this applies to templates only.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"blueprintPath": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "blueprintPath": "", "requestId": -1 }

Message: PageChannelChanged

Message Type: /Script/AvalancheMedia.AvaRundownPageChannelChanged

Event sent when a page's channel is modified.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"channelName": "",
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "channelName": "", "requestId": -1 }

Message: PageNameChanged

Message Type: /Script/AvalancheMedia.AvaRundownPageNameChanged

Event sent when a page's name is modified.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"pageName": "",
		"bFriendlyName": true,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "pageName": "", "bFriendlyName": true, "requestId": -1 }

Message: PageAnimSettingsChanged

Message Type: /Script/AvalancheMedia.AvaRundownPageAnimSettingsChanged

Event sent when a page's animation settings is modified.

Properties:

Json Format:

	{
		"rundown": "",
		"pageId": -1,
		"requestId": -1
	}
Copy full snippet

{ "rundown": "", "pageId": -1, "requestId": -1 }

Message: PageSequenceEvent

Message Type: /Script/AvalancheMedia.AvaRundownPageSequenceEvent

This message is sent by the server when a page sequence event occurs.

Properties:

Json Format:

	{
		"channel": "",
		"pageId": -1,
		"instanceId": "00000000000000000000000000000000",
		"assetPath": "",
		"sequenceLabel": "",
		"event": "None",
		"requestId": -1
	}
Copy full snippet

{ "channel": "", "pageId": -1, "instanceId": "00000000000000000000000000000000", "assetPath": "", "sequenceLabel": "", "event": "None", "requestId": -1 }

Message: PageTransitionEvent

Message Type: /Script/AvalancheMedia.AvaRundownPageTransitionEvent

This message is sent by the server when a page transition event occurs.

Properties:

Json Format:

	{
		"channel": "",
		"transitionId": "00000000000000000000000000000000",
		"enteringPageIds": [],
		"playingPageIds": [],
		"exitingPageIds": [],
		"event": "None",
		"requestId": -1
	}
Copy full snippet

{ "channel": "", "transitionId": "00000000000000000000000000000000", "enteringPageIds": [], "playingPageIds": [], "exitingPageIds": [], "event": "None", "requestId": -1 }

Message: Profiles

Message Type: /Script/AvalancheMedia.AvaRundownProfiles

Response to Request: GetProfiles. Contains the list of all profiles in the broadcast configuration.

Properties:

Json Format:

	{
		"profiles": [],
		"currentProfile": "",
		"requestId": -1
	}
Copy full snippet

{ "profiles": [], "currentProfile": "", "requestId": -1 }

Message: DevicesList

Message Type: /Script/AvalancheMedia.AvaRundownDevicesList

Response to Request: GetDevices.

Properties:

Json Format:

	{
		"deviceClasses": [],
		"requestId": -1
	}
Copy full snippet

{ "deviceClasses": [], "requestId": -1 }

Message: ChannelListChanged

Message Type: /Script/AvalancheMedia.AvaRundownChannelListChanged

This message is sent by the server if the list of channels is modified in the current profile. Channel added, removed, pinned or type (preview vs program) changed.

Properties:

Json Format:

	{
		"channels": [],
		"requestId": -1
	}
Copy full snippet

{ "channels": [], "requestId": -1 }

Message: ChannelResponse

Message Type: /Script/AvalancheMedia.AvaRundownChannelResponse

This message is sent by the server in response to Request: GetChannel or as an event if a channel's states, render target, devices or settings is changed.

Properties:

Json Format:

	{
		"channel":
		{
			"name": "",
			"type": "Program",
			"state": "Offline",
			"issueSeverity": "None",
			"devices": []
		},
		"requestId": -1
	}
Copy full snippet

{ "channel": { "name": "", "type": "Program", "state": "Offline", "issueSeverity": "None", "devices": [] }, "requestId": -1 }

Message: Channels

Message Type: /Script/AvalancheMedia.AvaRundownChannels

Response to Request: GetChannels

Properties:

Json Format:

	{
		"channels": [],
		"requestId": -1
	}
Copy full snippet

{ "channels": [], "requestId": -1 }

Message: AssetsChanged

Message Type: /Script/AvalancheMedia.AvaRundownAssetsChanged

Event broadcast when an asset event occurs on the server.

Properties:

Json Format:

	{
		"assetName": "",
		"assetPath": "",
		"assetClass": "",
		"bIsPlayable": false,
		"eventType": "Unknown",
		"requestId": -1
	}
Copy full snippet

{ "assetName": "", "assetPath": "", "assetClass": "", "bIsPlayable": false, "eventType": "Unknown", "requestId": -1 }

Message: ChannelImage

Message Type: /Script/AvalancheMedia.AvaRundownChannelImage

Response to Request: GetChannelImage.

Properties:

Json Format:

	{
		"imageData": [],
		"requestId": -1
	}
Copy full snippet

{ "imageData": [], "requestId": -1 }

Message: ChannelQualitySettings

Message Type: /Script/AvalancheMedia.AvaRundownChannelQualitySettings

Response to Request: GetChannelQualitySettings.

Properties:

Json Format:

	{
		"channelName": "",
		"features": [],
		"requestId": -1
	}
Copy full snippet

{ "channelName": "", "features": [], "requestId": -1 }

Struct: Guid

A globally unique identifier (mirrored from FGuid)

Properties:

Json Format:

	{
		"a": 0,
		"b": 0,
		"c": 0,
		"d": 0
	}
Copy full snippet

{ "a": 0, "b": 0, "c": 0, "d": 0 }

Struct: SoftObjectPath

A struct that contains a string reference to an object, either a top level asset or a subobject. Note: The full C++ class is located here: FSoftObjectPath

Properties:

Json Format:

	{
		"assetPath": "None",
		"subPathString": ""
	}
Copy full snippet

{ "assetPath": "None", "subPathString": "" }

Struct: TopLevelAssetPath

A struct that can reference a top level asset such as '/Path/To/Package.AssetName' Note: The full C++ class is located here: FTopLevelAssetPath

Properties:

Json Format:

	{
		"packageName": "None",
		"assetName": "None"
	}
Copy full snippet

{ "packageName": "None", "assetName": "None" }

Struct: CreatePageIdGeneratorParams

Defines the parameters for the page id generator algorithm. The Id generator uses a sequence strategy to search for an unused id. It is defined by a starting id and a search direction.

Properties:

Json Format:

	{
		"referenceId": -1,
		"increment": 1
	}
Copy full snippet

{ "referenceId": -1, "increment": 1 }

Struct: PageInfo

Page Information

Properties:

Json Format:

	{
		"pageId": -1,
		"pageName": "",
		"pageSummary": "",
		"friendlyName": "",
		"isTemplate": false,
		"templateId": -1,
		"combinedTemplateIds": [],
		"assetPath": "None",
		"statuses": [],
		"transitionLayerName": "",
		"bTransitionLogicEnabled": false,
		"commands": [],
		"outputChannel": "",
		"bIsEnabled": false,
		"bIsPlaying": false
	}
Copy full snippet

{ "pageId": -1, "pageName": "", "pageSummary": "", "friendlyName": "", "isTemplate": false, "templateId": -1, "combinedTemplateIds": [], "assetPath": "None", "statuses": [], "transitionLayerName": "", "bTransitionLogicEnabled": false, "commands": [], "outputChannel": "", "bIsEnabled": false, "bIsPlaying": false }

Struct: ChannelPageStatus

Properties:

Json Format:

	{
		"type": "Program",
		"status": "Unknown",
		"bNeedsSync": false
	}
Copy full snippet

{ "type": "Program", "status": "Unknown", "bNeedsSync": false }

Struct: PageCommandData

Page command data is stored in json serialized string in the page to be compatible with external apps.

Properties:

Json Format:

	{
		"name": "",
		"payload": ""
	}
Copy full snippet

{ "name": "", "payload": "" }

Struct: PlayableRemoteControlValues

Container for the remote control values of a playable.

Properties:

Json Format:

	{
		"entityValues":
		{
		},
		"controllerValues":
		{
		}
	}
Copy full snippet

{ "entityValues": { }, "controllerValues": { } }

Struct: PlayableRemoteControlValue

Properties:

Json Format:

	{
		"value": "",
		"bIsDefault": false
	}
Copy full snippet

{ "value": "", "bIsDefault": false }

Struct: OutputClassItem

Output Device Class Information

Properties:

Json Format:

	{
		"name": "",
		"server": "",
		"devices": []
	}
Copy full snippet

{ "name": "", "server": "", "devices": [] }

Struct: OutputDeviceItem

Output Device information

Properties:

Json Format:

	{
		"name": "",
		"outputInfo":
		{
			"guid": "00000000000000000000000000000000",
			"serverName": "",
			"deviceProviderName": "None",
			"deviceName": "None"
		},
		"outputState": "Invalid",
		"issueSeverity": "None",
		"issueMessages": [],
		"data": ""
	}
Copy full snippet

{ "name": "", "outputInfo": { "guid": "00000000000000000000000000000000", "serverName": "", "deviceProviderName": "None", "deviceName": "None" }, "outputState": "Invalid", "issueSeverity": "None", "issueMessages": [], "data": "" }

Struct: BroadcastMediaOutputInfo

Extra information about the Media Output object. This is used to determine the status of server hosting the device.

Properties:

Json Format:

	{
		"guid": "00000000000000000000000000000000",
		"serverName": "",
		"deviceProviderName": "None",
		"deviceName": "None"
	}
Copy full snippet

{ "guid": "00000000000000000000000000000000", "serverName": "", "deviceProviderName": "None", "deviceName": "None" }

Struct: Channel

Channel Information

Properties:

Json Format:

	{
		"name": "",
		"type": "Program",
		"state": "Offline",
		"issueSeverity": "None",
		"devices": []
	}
Copy full snippet

{ "name": "", "type": "Program", "state": "Offline", "issueSeverity": "None", "devices": [] }

Struct: ViewportQualitySettingsFeature

Properties:

Json Format:

	{
		"name": "",
		"bEnabled": false
	}
Copy full snippet

{ "name": "", "bEnabled": false }

Enum: ServerBuildTargetType

Build targets. This will help determine the set of features that are available.

Values:

Enum: ServerEngineMode

An editor build can be launched in different modes but it could also be a dedicated build target. The engine mode combined with the build target will determine the set of functionalities available.

Values:

Enum: BroadcastChannelType

The channel type defines what it is used for in the broadcast framework.

Primarily, the channel type is intended to resolve channel collisions between simultaneous "program" and "preview" playbacks on a given system. In other words:

• Channel selection for rundown pages is restricted to "program" channels.
• Channel selection for preview is restricted to "preview" channels.

It is thus not possible for a user to mistakenly select the same channel for both preview and program.

Some additional restrictions are applied according to channel type:

• preview channels must only have outputs local to the process. "Remote" previews are not supported.
• [backend] playback request type (program or preview) must match with the channel type. This is a safety net for any other extended code paths that are not in the Motion Design plugin.

Values:

Enum: PageStatus

Values:

Enum: PageListType

Rundown's page list type.

Values:

Enum: PageActions

Supported Page actions for playback.

Values:

Enum: TransitionActions

Supported Transition actions for playback.

Values:

Enum: TransitionLayerActions

Supported Page Logic Layer actions for playback.

Values:

Enum: PlayableSequenceEventType

Values:

Enum: PageTransitionEvents

Values:

Enum: BroadcastOutputState

Status of the media output.

Values:

Enum: BroadcastIssueSeverity

In case the broadcast device is Live (see EAvaBroadcastOutputState), this extra status indicates if the device is operating normally.

Values:

Enum: BroadcastChannelState

Channel state is a union summary of the output's states.

Values:

Enum: AssetEvent

Generic asset event

Values:

Enum: ChannelActions

Channel broadcast actions

Values:

Enum: ChannelEditActions

Values: