VideoMixer.OSDItemNormalizedRectGet method |
|
Remarks
Obtains the normalized rectangle, respect to the On-Screen-Display (OSD) area, for the given item of the OSD.
For further details about the use of the embedded video mixer see the VideoMixer object section.
For details about video mixing/blending refer to the How to use the video mixer tutorial.
Syntax
[Visual Basic] Public Function OSDItemNormalizedRectGet ( nMixerUniqueId as Int32, nItemUniqueId as Int32, ByRef fLeft as Single, ByRef fTop as Single, ByRef fRight as Single, ByRef fBottom as Single ) as enumErrorCodes |
[C#] public enumErrorCodes OSDItemNormalizedRectGet ( Int32 nMixerUniqueId, Int32 nItemUniqueId ref float fLeft, ref float fTop, ref float fRight, ref float fBottom ); |
[C++] public: enumErrorCodes OSDItemNormalizedRectGet ( Int32 nMixerUniqueId, Int32 nItemUniqueId float __gc *fLeft, float __gc *fTop, float __gc *fRight, float __gc *fBottom ); |
Parameter |
Description |
|
|
nMixerUniqueId |
Unique identifier of the video mixer returned by a previous call to the VideoMixer.Create method |
nItemUniqueId |
Unique identifier of the item returned by a previous call to one between the following methods: VideoMixer.OSDItemPictureFileAdd, VideoMixer.OSDItemBitmapAdd, VideoMixer.OSDItemTextAdd or VideoMixer.OSDItemRectangleAdd |
fLeft |
Reference that, on return from the method call, will contain the current left position, expressed in percentage, of the OSD's rectangle respect to the video mixer window area |
fTop |
Reference that, on return from the method call, will contain the current top position, expressed in percentage, of the OSD's rectangle respect to the video mixer window area |
fRight |
Reference that, on return from the method call, will contain the current right position, expressed in percentage, of the OSD's rectangle respect to the video mixer window area |
fBottom |
Reference that, on return from the method call, will contain the current bottom position, expressed in percentage, of the OSD's rectangle respect to the video mixer window area |
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. |