Vindral CDN Metadata Target
Vindral CDN Metadata Target properties for Script Engine. Sends arbitrary text metadata into a running Vindral CDN stream so it can be picked up by players in real time. Useful for in-stream cuepoints, score updates in sports broadcasts, program titles and chapter markers, song/track information for radio-style streams, or triggering interactive overlays on the viewer side. Metadata can be sent on demand via SendMetadataCommand or scripted from the Script Engine.
| Property | Type | Access | Description |
|---|---|---|---|
CdnEndPoint |
string |
get/set |
Full URL of the Vindral CDN metadata API for this stream. Provided by the Vindral CDN dashboard for the channel you are publishing to. Example: https://api.vindral.com/v1/streams/<stream-id>/metadata. Treat as a credential — avoid checking project files into public repositories with this filled in. |
PrivateId |
string |
get/set |
Private GUID identifying this metadata sender to the Vindral CDN. Generated automatically the first time the target is created. Treat as a secret — do not commit project files containing this value to public repositories. |
StartCommand |
Command |
get |
Activates the target so the SendMetadataCommand button can be used and Script Engine calls succeed. The target must be started before any metadata can be sent. |
StopCommand |
Command |
get |
Deactivates the target. Pending metadata calls are not sent and the command buttons are disabled until StartCommand is invoked again. |
SendMetadataCommand |
Command |
get |
Sends the current Message text into the running CDN stream. Use from the Script Engine when a cuepoint, score change or program transition should reach connected viewers immediately. |
Delay |
int |
get/set |
Delay in milliseconds between calling SendMetadataCommand and actually firing the request. Useful for compensating for the encoding latency of a paired video target so the metadata arrives at viewers in sync with the matching video frame. [default=0]. |
LastApiCall |
DateTime |
get |
Date and time the last metadata call was sent to the CDN (read-only, debug). |
Message |
string |
get/set |
Metadata text payload to send. Set this from the Script Engine before calling SendMetadataCommand, or wire it up to a UI text field so an operator can type a cuepoint message during the show. |
SendTestMessageCommand |
Command |
get |
Sends the text in TestmessageToSend to the CDN. Useful during pre-show setup to confirm that the endpoint, private ID and network path all work without disturbing the live Message value. |
TestmessageToSend |
string |
get/set |
Test payload used by SendTestMessageCommand. Set to whatever string your downstream player or CDN dashboard expects so you can verify the round trip without touching the live Message. |
Minilog |
FormattedMessage |
get/set |
Latest status or error message from the target (read-only, debug). |
Status |
GenericComponentStatus |
get |
Current status of the target. Active means metadata can be sent; Inactive means the target is stopped and SendMetadataCommand will be ignored. |
Inherits from: AbstractTarget.
See also: Vindral CDN Metadata Target in Targets — user-facing introduction, screenshots, and section summaries.