Collapse All Expand All

IltmmRTSPServer::put_SourceFolder

#include "ltmm.h"

C Syntax	HRESULT IltmmRTSPServer_put_SourceFolder(pThis, index, newValue)
C++ Syntax	HRESULT put_SourceFolder(index, newValue)

 

IltmmRTSPServer *pThis;	/* pointer to the interface */
long index;	/* folder index */
BSTR newValue;	/* the source folder path */

Adds, modifies or removes a folder from the internal source folder list.

Parameter	Description
pThis	Pointer to the IltmmRTSPServer interface.
index	0-based index of the source folder that should be set. The source folders are stored as an array of folder names. Can be set to -1 to indicate the folder should be added to the end of the list.
newValue	String containing the folder name. The folder names are absolute and should be fully specified. It can be NULL if you intend to remove the folder at index value equal to the 'index' parameter.

Returns

S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

The RTSP Server keeps an internal list of folders which store the source files for the server. When a client asks for a file to stream, the RTSP Server will look for the requested file in this source folder list, in order.

So the server looks in the first folder first. If it doesn't find it, it looks in the next folder and so on until it finds a filter containing the requested file.

This function allows you to modify the server list. You can add, modify or remove folders from this list as follows:

1. Add folders to the list by setting index to -1 or SourceCount and newValue != NULL (where SourceCount is the number of folders in the list, as indicated by IltmmRTSPServer::get_SourceCount).

2. Modify folders in the list by setting index to a value between 0 and SourceCount - 1 and newValue != NULL

3. Remove folders from the list by setting index to a value between 0 and SourceCount - 1 and newValue = NULL

Required DLLs and Libraries

LTMM For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:	IltmmRTSPServer interface, IltmmRTSPServer::get_SourceFolder
Topics:	Multimedia Function Groups Use IltmmRTPServer to implement a RTSP Server

Example

For a C++ example, refer to IltmmRTSPServer Example for C++.