summaryrefslogtreecommitdiff
path: root/pjsip-apps/src/samples/playfile.c
diff options
context:
space:
mode:
Diffstat (limited to 'pjsip-apps/src/samples/playfile.c')
-rw-r--r--pjsip-apps/src/samples/playfile.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/pjsip-apps/src/samples/playfile.c b/pjsip-apps/src/samples/playfile.c
index 5b26cd57..754304b3 100644
--- a/pjsip-apps/src/samples/playfile.c
+++ b/pjsip-apps/src/samples/playfile.c
@@ -26,6 +26,22 @@
#include "util.h"
+/**
+ * \page page_pjmedia_samples_playfile_c Samples: Playing WAV File to Sound Device
+ *
+ * This is a very simple example to use the @ref PJMEDIA_FILE_PLAY and
+ * @ref PJMED_SND_PORT. In this example, we open both the file and sound
+ * device, and connect the two of them, and voila! Sound will be playing
+ * the contents of the file.
+ *
+ * @see page_pjmedia_samples_recfile_c
+ *
+ * This file is pjsip-apps/src/samples/playfile.c
+ *
+ * \includelineno playfile.c
+ */
+
+
/*
* playfile.c
*