diff -r 424babd6b788 -r c4169fee6878 gst-plugins-mythtv/src/gstmythtvsrc.c --- a/gst-plugins-mythtv/src/gstmythtvsrc.c Mon Apr 16 16:02:22 2007 +0100 +++ b/gst-plugins-mythtv/src/gstmythtvsrc.c Tue Apr 17 21:13:22 2007 +0100 @@ -17,12 +17,28 @@ * Boston, MA 02111-1307, USA. */ /** + * SECTION:element-mythtvsrc + * + * + * + * MythTVSrc allows to access a remote MythTV backend streaming Video/Audio server, + * and to render audio and video content through a TCP/IP connection to a specific + * port on this server, and based on a known MythTV protocol that is based on + * some message passing, such as REQUEST_BLOCK on a specified number of bytes, to get + * some chunk of remote file data. + * You should pass the information aboute the remote MythTV backend server + * through the location property. + * + * Examples + * * If you want to get the LiveTV content (set channel, TV tuner, RemoteEncoder, * Recorder), * put the following URI: * - * myth://xxx.xxx.xxx.xxx:6543/livetv?channel=BBC - * + * + * myth://xxx.xxx.xxx.xxx:6543/livetv?channel=BBC + * + * * This URI will say to the gmyth library to configure the Recorder instance (used to * change the channel, start the TV multimedia content transmition, etc.), using * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend @@ -30,8 +46,10 @@ * * To get a already recorded the MythTV NUV file, put the following URI: * - * myth://xxx.xxx.xxx.xxx:6543/filename.nuv - * + * + * myth://xxx.xxx.xxx.xxx:6543/filename.nuv + * + * * This URI will say to the gmyth library to configure the Recorder instance (used to * change the channel, start the TV multimedia content transmition, etc.), using * the IP address (xxx.xxx.xxx.xxx) and port number (6543) of the MythTV backend @@ -40,13 +58,16 @@ * Another possible way to use the LiveTV content, and just in the case you want to * use the mysql database, put the location URI in the following format: * - * myth://mythtv:mythtv@xxx.xxx.xxx.xxx:6543/?mythconverg&channel=9 + * + * myth://mythtv:mythtv@xxx.xxx.xxx.xxx:6543/?mythconverg&channel=9 + * * * Where the first field is the protocol (myth), the second and third are user * name (mythtv) and password (mythtv), then backend host name and port number, * and the last field is the database name (mythconverg). + * + * */ - #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -66,25 +87,25 @@ GST_DEBUG_CATEGORY_STATIC (mythtvsrc_debug); #define GST_CAT_DEFAULT mythtvsrc_debug -#define GST_GMYTHTV_ID_NUM 1 +#define GST_GMYTHTV_ID_NUM 1 -#define GST_GMYTHTV_CHANNEL_DEFAULT_NUM (-1) +#define GST_GMYTHTV_CHANNEL_DEFAULT_NUM (-1) #define GMYTHTV_VERSION_DEFAULT 30 -#define GMYTHTV_TRANSFER_MAX_WAITS 100 +#define GMYTHTV_TRANSFER_MAX_WAITS 100 -#define GMYTHTV_TRANSFER_MAX_RESENDS 2 +#define GMYTHTV_TRANSFER_MAX_RESENDS 2 -#define GMYTHTV_TRANSFER_MAX_BUFFER (128*1024) +#define GMYTHTV_TRANSFER_MAX_BUFFER (128*1024) -#define MAX_READ_SIZE (4*1024) +#define MAX_READ_SIZE (4*1024) -#define GST_FLOW_ERROR_NO_DATA (-101) +#define GST_FLOW_ERROR_NO_DATA (-101) -#define REQUEST_MAX_SIZE (64*1024) +#define REQUEST_MAX_SIZE (64*1024) -#define INTERNAL_BUFFER_SIZE (90*1024) +#define INTERNAL_BUFFER_SIZE (90*1024) static const GstElementDetails gst_mythtv_src_details = GST_ELEMENT_DETAILS ("MythTV client source",