vlc_vout_window.h File Reference

#include <vlc_common.h>

Go to the source code of this file.

Classes
struct	vout_window_cfg_t
struct	vout_window_t

Typedefs
typedef struct vout_window_t	vout_window_t
typedef struct vout_window_sys_t	vout_window_sys_t

Enumerations
enum	{ VOUT_WINDOW_TYPE_INVALID =0, VOUT_WINDOW_TYPE_XID, VOUT_WINDOW_TYPE_HWND, VOUT_WINDOW_TYPE_NSOBJECT }
enum	{ VOUT_WINDOW_SET_STATE, VOUT_WINDOW_SET_SIZE, VOUT_WINDOW_SET_FULLSCREEN }

Functions
VLC_API vout_window_t *	vout_window_New (vlc_object_t *, const char *module, const vout_window_cfg_t *)
VLC_API void	vout_window_Delete (vout_window_t *)
VLC_API int	vout_window_Control (vout_window_t *, int query,...)

Detailed Description

This file defines vout windows structures and functions in vlc

Enumeration Type Documentation

anonymous enum

Window handle type

anonymous enum

Control query for vout_window_t

Function Documentation

VLC_API int vout_window_Control	(	vout_window_t *	,
		int	query,
			...
	)

Reconfigures a window.

Note

The vout_window_* wrappers should be used instead of this function.

Warning

The caller must own the window, as vout_window_t is not thread safe.

VLC_API void vout_window_Delete

(

vout_window_t *

)

Deletes a window created by vout_window_New().

Note

See vout_window_New() about window recycling.

VLC_API vout_window_t* vout_window_New	(	vlc_object_t *	,
		const char *	module,
		const vout_window_cfg_t *
	)

Creates a new window.

Parameters

module

plugin name (usually "$window")

Note

If you are inside a "vout display", you must use / vout_display_NewWindow() and vout_display_DeleteWindow() instead. This enables recycling windows.