Description | Example | Return Message | Group

WinMedia2d

Set Windows Media WebCast options for the 2D graphics window.

Syntax

WinMedia2d <ScenarioPath> {WinMediaOptions}

Description

The WinMedia2d Connect command is used to set the Windows Media WebCast options for doing live broadcasts of STKfinish 2D Graphics windows using the WebCast tool and the Windows Media Player.

{WinMediaOptions} Description
Enabled {Yes | No} Enable streaming for this window.
OnAnimateOnly {Yes | No} If turned on this will send data to the connected clients, only when animating.
MaxClients <NumClients> Indicates the maximum number of clients that can be connected to the stream. <NumClients> is greater then 0
BitRate <BitRate> Rate of stream. The higher the bitrate, the higher the quality. <BitRate> is greater then 0
Quality <Quality> Use to maximize image quality. <Quality> is between 0 and 100
SecPerKey <SecPerKey> Indicates the number of frames that are sent between key frames. <SecPerKey> is greater then 0
FPS <FPS> Specifies the number of frames per second that are transmitted during streaming. <FPS> is greater then 0
Port <Port> For each streamed window, a different port must be specified. <Port> is greater then 0
WindowID <WinNumber> The id of the 2d graphics window to be streamed.

Example

Enable 2d graphics window 2 for streaming during animate only, at 15 frames per second:

WinMedia2d * Enabled Yes OnAnimateOnly yes FPS 15 WindowID 2

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Scenarios

Version

6.1

STK Programming Interface 11.0.1