---
name: "xine_api"
section: "3"
platform: "linux"
package: "libxine-dev"
version: "0.9.8-2woody3"
release: "Debian 3.0 (Woody)"
platforms: ["linux"]
url: "https://new.carta.tech/xine_api"
---

# xine\_api(3)

## NAME

API functions -

### Modules

**Sending events**\
 **Loading plugins**\
 **Autoplay support**\
 **Browsing support**\
 **Audio.**\
 **Engine management**\
 **Init functions**\
 **Video.**\
 **Version functions**\
 **Version constants**\
 **Player status constants**\

### Defines

\#define **XINE\_IMGFMT\_YV12**   0x32315659\
 \#define **XINE\_IMGFMT\_YUY2**   (('2'\<\<24)\|('Y'\<\<16)\|('U'\<\<8)\|'Y')\
 \#define **XINE\_ASPECT\_RATIO\_SQUARE**   1\
 \#define **XINE\_ASPECT\_RATIO\_4\_3**   2\
 \#define **XINE\_ASPECT\_RATIO\_ANAMORPHIC**   3\
 \#define **XINE\_ASPECT\_RATIO\_211\_1**   4\
 \#define **XINE\_ASPECT\_RATIO\_DONT\_TOUCH**   42\

### Functions

int **xine\_get\_current\_frame** (**xine\_t** \*self, int \*width, int \*height, int \*ratio\_code, int \*format, uint8\_t \*\*y, uint8\_t \*\*u, uint8\_t \*\*v)\
 *Snapshot function.*

## DEFINE DOCUMENTATION

### #define XINE\_ASPECT\_RATIO\_211\_1 4

aspect ratio.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_ASPECT\_RATIO\_4\_3 2

aspect ratio.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_ASPECT\_RATIO\_ANAMORPHIC 3

aspect ratio.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_ASPECT\_RATIO\_DONT\_TOUCH 42

aspect ratio.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_ASPECT\_RATIO\_SQUARE 1

aspect ratio.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_IMGFMT\_YUY2 (('2'\<\<24)\|('Y'\<\<16)\|('U'\<\<8)\|'Y')

image format.

**See also:**  **xine\_get\_current\_frame**

### #define XINE\_IMGFMT\_YV12 0x32315659

image format.

**See also:**  **xine\_get\_current\_frame**

## FUNCTION DOCUMENTATION

### int xine\_get\_current\_frame (xine\_t \* self, int \* width, int \* height, int \* ratio\_code, int \* format, uint8\_t \*\* y, uint8\_t \*\* u, uint8\_t \*\* v)

Snapshot function.

**Parameters:**

- *self*

  *Current xine engine configuration ( see* **xine\_init***() )*

- *width*

  *Width of image (be aware that u,v may be subsampled)*

- *height*

  *Height of image (be aware that u,v may be subsampled)*

- *ratio\_code*

  *Aspect ratio of the frame*

- *format*

  *Subsampling format YUV 4:2:0 or 4:2:2*

- *y*

  *Lumiance information*

- *u*

  *Subsample color information*

- *v*

  *Subsample color information*

**Returns:**  *1 on success, 0 failure.*

**Parameters:**

- *self*

  - *width*

  - *height*

  - *ratio\_code*

  - *format*

  - *y*

  - *u*

  - *v*