

This will unregister the player port from the conference bridge. Samples: The desired playback position, in samples. This operation is not valid for playlist.Ĭurrent playback position, in samples. Get current playback position in samples. Application may specify PJMEDIA_FILE_NO_LOOP to prevent looping. Label: Optional label to be set for the media port. Note that the files must have the same clock rate, number of channels, and number of bits per sample. Void createPlaylist ( const StringVector & file_names, const string & label = "", unsigned options = 0 ) ¶Ĭreate a file playlist media port, and automatically add the port to the conference bridge.įile_names: Array of file names to be added to the play list. Application may specify PJMEDIA_FILE_NO_LOOP to prevent playback loop. Currently only WAV files are supported, and the WAV file MUST be formatted as 16bit PCM mono/single channel (any clock rate is supported). void createPlayer ( const string & file_name, unsigned options = 0 ) ¶Ĭreate a file player, and automatically add this player to the conference bridge.įile_name: The filename to be played. We can also display class declaration with specific members.įor more info see `Breathe documentation `_Ĭonstructor. doxygenfunction:: pj::AudioMediaPlayer::createPlayer() * A class with alternate display: :cpp:class:`a class `įor that links to work, we need to display the link target declaration (a class or method)Īlternatively we can display a single method declaration like this: * A class :cpp:class:`pj::AudioMediaPlayer`


* A method with alternate display: :cpp:func:`a method ` * A method: :cpp:func:`pj::AudioMediaPlayer::createPlayer()`

Pj::AudioMediaPlayer *player = new AudioMediaPlayer
#Doxygen vs sphinx how to
MkDocs belongs to "Static Site Generators" category of the tech stack, while Sphinx can be primarily classified under "Search Engines".Īccording to the StackShare community, Sphinx has a broader approval, being mentioned in 42 company stacks & 73 developers stacks compared to MkDocs, which is listed in 5 company stacks and 8 developer stacks.This is how to quote a code with syntax coloring: A variety of text processing features enable fine-tuning Sphinx for your particular application requirements, and a number of relevance functions ensures you can tweak search quality as well. Sphinx lets you either batch index and search data stored in an SQL database, NoSQL storage, or just files quickly and easily - or index and search data on the fly, working with Sphinx pretty much as with a database server.
#Doxygen vs sphinx full
On the other hand, *Sphinx** is detailed as " Open source full text search server, designed from the ground up with performance, relevance (aka search quality), and integration simplicity in mind". It will even auto-reload and refresh your browser whenever you save your changes. The built-in dev-server allows you to preview your documentation as you're writing it. There's a stack of good looking themes available. It builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
#Doxygen vs sphinx generator
MkDocs vs Sphinx: What are the differences?ĭevelopers describe MkDocs as " A static site generator *".
