FFqlay Documentation

Table of Contents

• 1. Introduction
• 2. API Functions
  • 2.1 FFQLAY_start()
  • 2.2 FFQLAY_get_play_state()
  • 2.3 FFQLAY_pause()
  • 2.4 FFQLAY_stop()
  • 2.5 FFQLAY_get_duration()
  • 2.6 FFQLAY_get_position()
  • 2.7 FFQLAY_set_position()
  • 2.8 FFQLAY_resize()
  • 2.9 FFQLAY_get_volume()
  • 2.10 FFQLAY_set_volume()

FFqlay Documentation

1. Introduction

FFqlay is a media playback library based on FFmpeg. FFqlay is based on the FFplay which is the media player in FFmpeg project and intends to be used on Win32. FFqlay makes some minor modifications on FFplay to provide a set of API functions. By using FFqlay, you can develop your media player which supports all codecs in FFmpeg easily. A C# sample program is included in FFqlay project.

2. API Functions

The API functions in FFqlay are written in C. The functions try to fullfill the needs of media playback. In this section, all functsion are briefly introduced.

2.1 FFQLAY_start()

int FFQLAY_start(int argc, char **argv, HWND hwndParent, int width, int height);

FFQLAY_start is used to start the playback of a media file. The arguments argc and argv are passed as the command line arguments of the original FFplay. You can specify the options supported by FFplay by passing proper values of the two arguments. In the simplest case, argc could be "2" ,argv[0] is the filename of your executable, and argv[1] is the path of the media file.

If you would like make the video window be the child window of another window, you can pass the window handle as hwndParent. Otherwise, you can pass NULL.

In addition, you can specify the width and height of the video window by passing width and height.

2.2 FFQLAY_get_play_state()

int FFQLAY_get_play_state(void);

After calling FFQLAY_start, a thread is created to exectue the internal event_loop(). It does not block the execution of the caller thread. How can the application to determine whether the playback is completed or not? By using FFQLAY_get_play_state(), the state of playback can be returned. FFQLAY_get_play_state() may return the following values,

int FFQLAY_pause(void);

int FFQLAY_stop(void);

double FFQLAY_get_duration(void);

double FFQLAY_get_position(void);

int FFQLAY_set_position(double position);

int FFQLAY_resize(int width, int height);

int FFQLAY_get_volume(void);

int FFQLAY_set_volume(int volume);