Copyright © 2005-2018 MultiMedia Soft

VideoPlayer.VideoStreamKeepAspectRatio method

Previous pageReturn to chapter overviewNext page

Remarks

 

Tells to the given player if the related video output windows must keep the original aspect ratio of the loaded video clip.

 

For further details about the use of the embedded video player see the VideoPlayer class section.

For details about video clips rendering refer to the How to play video files through DirectShow tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function VideoStreamKeepAspectRatio (

nPlayerIndex as Int16,

bKeepAspectRatio as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes VideoStreamKeepAspectRatio (

Int16 nPlayerIndex,

bool bKeepAspectRatio

);


 

[C++]

public: enumErrorCodes VideoStreamKeepAspectRatio (

Int16 nPlayerIndex,

bool bKeepAspectRatio

);


 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the player that will use the video player.

bKeepAspectRatio

Boolean value that determines if the loaded video clip must keep its original aspect ratio.

Supported values are the following:

Mnemonic constant

Meaning

false

Don't keep the original aspect ratio

true (default)

Keep the original aspect ratio

 

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.