Function: app.ShowVideo

Shows the video source on the given target.

Requires AOP API version wg 0.4.0 or later.

Syntax

{
	"method": "app.ShowVideo",
	"params": {
		"sourceid": "...",
		"targeturl": "...",
		"targetid": "...",
		"targetpane": "...",
		"stream": "...",
		"mode": "...",
		"speed": "...",
		"time": "...",
		"markeroffset": "...",
		"markerduration": "...",
		"loop": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> ShowVideo( AdvGuid sourceid
	 std::optional<AdvString> targeturl = std::nullopt,
	 std::optional<AdvGuid> targetid = std::nullopt,
	 std::optional<AdvString> targetpane = std::nullopt,
	 std::optional<AdvString> stream = std::nullopt,
	 std::optional<AdvString> mode = std::nullopt,
	 std::optional<AdvString> speed = std::nullopt,
	 std::optional<AdvTime> time = std::nullopt,
	 std::optional<int> markeroffset = std::nullopt,
	 std::optional<int> markerduration = std::nullopt,
	 std::optional<bool> loop = std::nullopt );
public Task<bool> ShowVideoAsync(Guid sourceid,
		string? targeturl = null,
		Guid? targetid = null,
		string? targetpane = null,
		string? stream = null,
		string? mode = null,
		string? speed = null,
		DateTime? time = null,
		long? markeroffset = null,
		long? markerduration = null,
		bool? loop = null,
		CancellationToken ct = default);
showVideo(sourceid: string, targeturl?: string | undefined, targetid?: string | undefined, targetpane?: string | undefined, stream?: string | undefined, mode?: string | undefined, speed?: string | undefined, time?: Date | undefined, markeroffset?: number | undefined, markerduration?: number | undefined, loop?: boolean | undefined): Promise<boolean>;

Parameters

sourceid : guid

ID of the camera datatpoint. If the ID is the null GUID, the command will remove the camera on the target.

targeturl : string optional

Only necessary if the target is the Video Manager, a display or the camera control panel. Only the following types of URLs are allowed: “VideoManager[1..4]”, “VideoDisplay[1..4]/Window[1..4]” and “VideoPanel”

targetid : guid optional

ID of the target Datapoint. Only necessary when targeturl is empty.

targetpane : string optional

The area of the target, which should show the camera.

stream : string optional

The video stream, which should be shown.

mode : string optional

Sets live or archive mode. Only the following values are allowed: “live” and “archive”.

speed : string optional

Only valid when mode=“archive”. The desired speed of the video. The sign indicates the direction. Only the following values are allowed: “0”, “0.125”, “0.25”, “0.5”, “1”, “2”, “4”, “8” and all of their negative counterparts.

time : time optional

Only valid when mode=“archive”. The time on which the video should start.

markeroffset : int optional

Only valid when mode=“archive”. An offset in seconds to define the time of the start marker in respect to the current time.

markerduration : int optional

Only valid when mode=“archive”. A duration in seconds. It defines the position of the end marker by defining the time range between start and end marker. If set to 0, the start and end marker are removed.

loop : bool optional

Only valid when mode=“archive”. Loop video between markers.

Result : bool

Success.

Remarks

This method requires API control access.