The Display API provides functions to control the display.
Required Header
#include <player.h>
Overview
The API allows you to manage the display of the player. This API provides functions to set and get various display properties:
Enumeration Type Documentation
Enumeration for x surface display aspect ratio.
- Since :
- 2.3
- Enumerator:
PLAYER_DISPLAY_MODE_LETTER_BOX |
Letter box
|
PLAYER_DISPLAY_MODE_ORIGIN_SIZE |
Origin size
|
PLAYER_DISPLAY_MODE_FULL_SCREEN |
Full-screen
|
PLAYER_DISPLAY_MODE_CROPPED_FULL |
Cropped full-screen
|
PLAYER_DISPLAY_MODE_ORIGIN_OR_LETTER |
Origin size (if surface size is larger than video size(width/height)) or Letter box (if video size(width/height) is larger than surface size)
|
PLAYER_DISPLAY_MODE_DST_ROI |
Dst ROI mode
|
Enumeration for display rotation type.
- Since :
- 2.3
- Enumerator:
PLAYER_DISPLAY_ROTATION_NONE |
Display is not rotated
|
PLAYER_DISPLAY_ROTATION_90 |
Display is rotated 90 degrees
|
PLAYER_DISPLAY_ROTATION_180 |
Display is rotated 180 degrees
|
PLAYER_DISPLAY_ROTATION_270 |
Display is rotated 270 degrees
|
Function Documentation
Gets the video display mode.
- Since :
- 2.3
- Parameters:
-
[in] | player | The handle to the media player |
[out] | mode | The current display mode |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- player_set_display_mode()
Gets the rotation of the video surface display.
- Since :
- 2.3
- Parameters:
-
[in] | player | The handle to the media player |
[out] | rotation | The current rotation of the display |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- player_set_display_rotation()
Gets the visibility of the x surface video display.
- Since :
- 2.3
- Parameters:
-
[in] | player | The handle to the media player |
[out] | visible | The current visibility of the display (true = visible, false = non-visible ) |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- player_set_display_visible()
Sets the video display mode.
- Since :
- 2.3
- Parameters:
-
[in] | player | The handle to the media player |
[in] | mode | The display mode |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- Precondition:
- The player should support display mode changes.
- See also:
- player_get_display_mode()
Sets the rotation settings of the video surface display.
- Since :
- 2.3
Use this function to change the video orientation to portrait mode.
- Parameters:
-
[in] | player | The handle to the media player |
[in] | rotation | The rotation of the display |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- player_set_display
-
player_get_display_rotation()
Sets the visibility of the x surface video display.
- Since :
- 2.3
- Parameters:
-
[in] | player | The handle to the media player |
[in] | visible | The visibility of the display (true = visible, false = non-visible ) |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- player_is_display_visible()