dmParams(3dm)							 dmParams(3dm)

NAME    [Toc]    [Back]

     dmParams: dmParamsCreate, dmParamsDestroy - create	and destroy digital
     media parameter/value lists

SYNOPSIS    [Toc]    [Back]

     #include <dmedia/dm_params.h>

     DMstatus dmParamsCreate(DMparams**	params)

     void dmParamsDestroy(DMparams* params)

DESCRIPTION    [Toc]    [Back]

     Parameter/value lists are used by the Digital Media Libraries to hold
     configuration information about digital video and movies.	There are
     standard parameters that apply to images (for video and movies) and
     standard parameters that apply to audio (for movies).

     The function dmParamsCreate is used to create a new (empty)
     parameter/value list.  This can be	filled in one of several ways:	(1)
     using the generic "set" functions such as dmParamsSetInt, (2) using a
     function to set up	the standard parameters	for images or audio
     (dmSetImageDefaults and dmSetAudioDefaults), or (3) using a function from
     one of the	digital	media libraries	(such as mvSetMovieDefaults).  If
     there is sufficient memory	to allocate the	structure, a pointer to	it is
     put into *params, and DM_SUCCESS is returned.  Otherwise, DM_FAILURE is
     returned.

     dmParamsDestroy frees a parameter/value list and all of its contents.

     In	order to simplify memory management, dmParamsCreate is the only
     function that will	create a parameter/value list, and dmParamsDestroy is
     the only function that will free one.  This means that parameter/value
     lists are managed correctly when every call to create one is balanced by
     a call to destroy one.

     The following example creates a parameter/value list and uses it to
     configure a new movie file:

EXAMPLE    [Toc]    [Back]

	      DMparams*	params;
	      if ( dmParamsCreate( &params ) !=	DM_SUCCESS ) {
		  printf( "Out of memory.\n" );
		  exit(	1 );
	      }
	      if ( mvSetMovieDefaults(params, MV_FORMAT_SGI_3) != DM_SUCCESS ) {
		  printf( "Out of memory.\n" );
		  exit(	1 );
	      }
	      if ( mvCreateFile("temp.mv", params, NULL, &movie) != DM_SUCCESS ) {
		  printf( "Could not create movie.\n" );
		  exit(	1 );
	      }



									Page 1






dmParams(3dm)							 dmParams(3dm)



	      dmParamsDestroy( params );

SEE ALSO    [Toc]    [Back]

     dmParamsSetInt(3dm), dmParamsGetInt(3dm), dmParamsSetIntArray(3dm),
     dmParamsGetIntArray(3dm), dmParamsGetIntRange(3dm),
     dmParamsSetIntRange(3db), dmParamsGetNumElems(3dm),
     dmSetImageDefaults(3dm), dmSetAudioDefaults(3dm).


									PPPPaaaaggggeeee 2222