tv_service_proxy_epg.h File Reference

#include "tv_service_proxy_base.h"

Go to the source code of this file.

Data Structures
struct	TvServiceEpgEventData

Macros
#define	TVS_EPG_UNDEFINED_TIME   (0)
#define	TVS_EPG_CURRENT_TIME   (-1)

Typedefs
typedef void *	TvServiceEpg
typedef void(*	TvServiceEpgCallback )(tvs_epg_event_e type, gpointer epg_data, gpointer user_data)

Enumerations
enum	tvs_epg_event_e {   TVS_EPG_CREATE = 0, TVS_EPG_DESTROY, TVS_EPG_GET_CURRENT_PROGRAM, TVS_EPG_GET_PROGRAM_LIST,   TVS_EPG_AUTO_DESTROY, TVS_EPG_DATA_UPDATED }

Functions
gint	tv_service_epg_create (TvServiceEpg *epg)
gint	tv_service_epg_destroy (TvServiceEpg epg)
gint	tv_service_epg_register_callback (TvServiceEpg epg, TvServiceEpgCallback callback_func, gpointer user_data)
gint	tv_service_epg_get_current_program (TvServiceEpg epg, guint service_id, TvServiceEpgCallback callback_func, gpointer user_data)
gint	tv_service_epg_get_program_list (TvServiceEpg epg, guint service_id, guint start_time, guint duration, TvServiceEpgCallback callback_func, gpointer user_data)
gint	tv_service_epg_get_cache_current_program (TvServiceEpg epg, guint service_id, TvServiceEpgEventData *app_data)

Detailed Description

This API is not official tv-service API. It can always be changed without announcement.

Macro Definition Documentation

#define TVS_EPG_CURRENT_TIME   (-1)

#define TVS_EPG_UNDEFINED_TIME   (0)

Examples:

tv_service_epg_test.c.

Typedef Documentation

typedef void* TvServiceEpg

typedef void(* TvServiceEpgCallback)(tvs_epg_event_e type, gpointer epg_data, gpointer user_data)

Enumeration Type Documentation

enum tvs_epg_event_e

An enumeration. Enumeration define epg event type.

Enumerator:

TVS_EPG_CREATE
TVS_EPG_DESTROY
TVS_EPG_GET_CURRENT_PROGRAM
TVS_EPG_GET_PROGRAM_LIST
TVS_EPG_AUTO_DESTROY
TVS_EPG_DATA_UPDATED

Function Documentation

gint tv_service_epg_create

(

TvServiceEpg *

epg

)

tv_service_epg_create:

*This function is to create a player object for epg.

Parameters

epg	[in] handle of epg

Returns

This function returns zero on success, or negative value with error code.

See Also

None.

Remarks

None.

Examples:

tv_service_epg_live_test.c, and tv_service_epg_test.c.

gint tv_service_epg_destroy

(

TvServiceEpg

epg

)

tv_service_epg_destroy:

*This function is to destroy a player object for epg.

Parameters

epg	[in] handle of epg

Returns

This function returns zero on success, or negative value with error code.

See Also

None.

Remarks

None.

Examples:

tv_service_epg_live_test.c, and tv_service_epg_test.c.

gint tv_service_epg_get_cache_current_program	(	TvServiceEpg	epg,
		guint	service_id,
		TvServiceEpgEventData *	app_data
	)

tv_service_epg_get_cache_current_program:

*This function is to get current program of epg from database.

Parameters

epg	[in] handle of epg
service_id	[in] service_id
app_data	[inout] application data

Returns

This function returns zero on success, or negative value with error code.

See Also

None.

Remarks

None.

Examples:

tv_service_epg_test.c.

gint tv_service_epg_get_current_program	(	TvServiceEpg	epg,
		guint	service_id,
		TvServiceEpgCallback	callback_func,
		gpointer	user_data
	)

tv_service_epg_get_current_program:

*This function is to get current program of epg.

Parameters

epg	[in] handle of epg
service_id	[in] service_id
callback_func	[in] callback function
user_data	[in] callback user_data

Returns

This function returns zero on success, or negative value with error code.

See Also

None.

Remarks

None.

Examples:

tv_service_epg_live_test.c, and tv_service_epg_test.c.

gint tv_service_epg_get_program_list	(	TvServiceEpg	epg,
		guint	service_id,
		guint	start_time,
		guint	duration,
		TvServiceEpgCallback	callback_func,
		gpointer	user_data
	)

tv_service_epg_get_program_list:

*This function is to get program list of epg.

Parameters

epg	[in] handle of epg
service_id	[in] service_id
start_time	[in] start_time, TVS_EPG_UNDEFINED_TIME for all time, TVS_EPG_CURRENT_TIME for current time
duration	[in] duration
callback_func	[in] callback function
user_data	[in] callback user_data

Returns

This function returns zero on success, or negative value with error code.

See Also

None.

Remarks

None.

Examples:

tv_service_epg_test.c.

gint tv_service_epg_register_callback	(	TvServiceEpg	epg,
		TvServiceEpgCallback	callback_func,
		gpointer	user_data
	)

This function sets callback function for receiving messages from daemon. So, epg can notify events to application.

Parameters

epg	[in] Handle of epg.
callback_func	[in] Message callback function.
user_data	[in] User user_data.

Returns

This function returns zero on success, or negative value with error code.

See Also

tv_service_epg_register_callback.

Remarks

None.

Examples:

tv_service_epg_live_test.c, and tv_service_epg_test.c.