Cinegy Player PRO COM API Manual

IPlayerAPI Interface

The IPlayerAPI interface provides properties and methods to cooperate with the Player UI component. So, you can integrate Cinegy Player PRO into your application and use it in your customized workflow.

Method Description

CheckLicense

Verifies the existing “Cinegy Player” free license. Returns PlayerErrors enum value, which can be interpreted with the FromPlayerError method.

Clear

Resets target media and player control presets.

FromPlayerError

Gets description for PlayerErrors enum value.

LoadFile

Opens file-based media target, including MCRItem extension.

LoadPlaylistXml

Opens XML-content media target with specified parameters.

Play

Plays loaded media target.

Stop

Stops playing media target at the current position.

SetAudio0Level

Changes the zero level of the audio VU meter (-21..0).

ShowVANC

Enables/disables preview of VANC data.

SetAspect

Sets the aspect ratio for the media target.

SetCCDecoding

Sets decoding type for reading Closed Captions from the media target. The input parameters are the Closed Captions type and the index of the specified type service.
Property Description

Duration

Gets media duration.

FrameRate

Gets media frame rate.

IsPlaying

Indicates playback status.

IsLoaded

Indicates loading status.

MarkIn

Gets or sets the initial point for playback.

MarkOut

Gets or sets the final point for playback.

Position

Gets or sets the playback point.

ReadOnly

Gets or sets accessibility to disable options:

  • set In and Out points;

  • delete In and Out points.

AspectType

The AspectType enum type members are:

  • Origin

  • Aspect4X3

  • Aspect16X9

PlayerErrors

The PlayerErrors enum type members are:

  • NO_ERRORS

  • NOT_SUPPORTED

  • NO_LICENCE

  • LICENSE_GENERAL_ERROR

  • REQUIRES_PRO

  • OUTDATED_VERSION

CCType

The CCType enum type members are:

  • CC_None

  • CC_608

  • CC_708

IPlayerEvents Interface

The IPlayerEvents interface provides events. So, you can subscribe to these Cinegy Player PRO events to communicate with other components or customize existing player logic as required by your scenario.

Event Description

MenuClickedEvent

Occurs when the Player context menu is clicked.

MarkInEvent

Occurs when the initial point for playback is changed.

ClearInEvent

Occurs when the initial point for playback is cleared.

MarkOutEvent

Occurs when the final point for playback is changed.

ClearOutEvent

Occurs when the final point for playback is cleared.

OpenFileEvent

Occurs when the file media target is opened.

OpenFileFailedEvent

Occurs when opening a file media target fails.

PlayEvent

Occurs when playing is initiated.

PauseEvent

Occurs when the media target is paused.

ClearEvent

Occurs when clearing the player is initiated.