Misc. utility functions [Functions]

Functions
QUVIcode	quvi_supported (quvi_t quvi, char *url)
	Checks whether the URL would be supported by one of the scripts.
QUVIcode	quvi_next_supported_website (quvi_t quvi, char **domain, char **formats)
	Return next supported video website.
QUVIcode	quvi_next_host (char **domain, char **formats)
	Next supported video host.
char *	quvi_strerror (quvi_t quvi, QUVIcode code)
	Return a string describing the error code.
char *	quvi_version (QUVIversion type)
	Return libquvi version.
void	quvi_free (void *ptr)
	Free allocated memory.

---

Function Documentation

QUVIcode quvi_supported	(	quvi_t	quvi,
		char *	url
	)

Checks whether the URL would be supported by one of the scripts.

This function does not require an Internet connection. Note that this function will return QUVI_NOSUPPORT for nearly all shortened (or "compressed") URLs as they require querying a redirection over the Internet. See the "Exceptions" below.

Parameters:

	quvi	Handle to session
	url	Null-terminated string to an URL

Note:

• Most shorteners require retrieving the redirection from the services before
• Returns QUVI_NOSUPPORT for most shortened URLs
• Examples:
  • is.gd
  • goo.gl
  • ...
• Exceptions:
  • youtu.be (script: youtube.lua)
  • dai.y (script: dailymotion.lua)
  • These services do not "compress" the video ID which can be used in the above scripts to reconstruct the original URL

Returns:

Non-zero if an error occurred

Examples:

quvi.c.

QUVIcode quvi_next_supported_website	(	quvi_t	quvi,
		char **	domain,
		char **	formats
	)

Return next supported video website.

This function can be used to iterate the supported websites.

Parameters:

	quvi	Handle to a session
	domain	Pointer to a null-terminated string (e.g. "youtube.com")
	formats	Pointer to a null-terminated string (e.g. "default|best|hq|hd")

Returns:

QUVI_OK or a non-zero value if an error occurred

• QUVI_LAST indicates end of the list of the websites
• Any other returned non-zero value indicates an actual error and should be handled accordingly (e.g. relaying the return code to quvi_strerror)

Note:

• Both domain and formats string must be quvi_free()d after use
• Return value QUVI_LAST is a non-zero value and indicates the end iteration
• Consider handling errors

Example:

 while (quvi_next_supported_website(quvi, &domain, &formats) == QUVI_OK) {
   printf("%s\t%s\n", domain, formats);
   quvi_free(domain);
   quvi_free(formats);
 }

Examples:

quvi.c.

QUVIcode quvi_next_host	(	char **	domain,
		char **	formats
	)

Next supported video host.

Iterate the list of the supported video hosts.

Parameters:

	domain	Pointer to a null-terminated string
	formats	Pointer to a null-terminated string

Returns:

QUVI_LAST (always)

Deprecated:

since 0.2.0, use quvi_next_supported_website() instead

char* quvi_strerror	(	quvi_t	quvi,
		QUVIcode	code
	)

Return a string describing the error code.

Parameters:

	quvi	Handle to a libquvi session
	code	Error code

Returns:

Null-terminated string

Warning:

Do not attempt to free the memory returned by this function

Example:

 quvi_t quvi;
 QUVIcode rc = quvi_init(&quvi);
 if (rc != QUVI_OK) {
   fprintf(stderr, "error: %s\n", quvi_strerror(quvi,rc));
   exit (rc);
 }
 quvi_close(&quvi);

Examples:

quvi.c, and simple.c.

char* quvi_version

(

QUVIversion

type

)

Return libquvi version.

Parameters:

type

Version type

Returns:

Null-terminated string

Warning:

Do not attempt to free the memory returned by this function

Example:

 puts( quvi_version(QUVI_VERSION_LONG) );

Examples:

quvi.c.

void quvi_free

(

void *

ptr

)

Free allocated memory.

Parameters:

ptr

Pointer to data

Examples:

quvi.c.