diff options
author | Erik de Castro Lopo <erikd@mega-nerd.com> | 2004-02-14 03:02:56 +0000 |
---|---|---|
committer | Erik de Castro Lopo <erikd@mega-nerd.com> | 2004-02-14 03:02:56 +0000 |
commit | bad679cfdd4bf4dfd5adeb7ce5745e4c6a18873f (patch) | |
tree | 478c067a559ac49c670aabd73baff68f912f1f58 /doc/command.html | |
parent | 26efcb703f328a8ed05ae12f2817a0d1d83d729e (diff) |
Fix typos on docs.
Diffstat (limited to 'doc/command.html')
-rw-r--r-- | doc/command.html | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/command.html b/doc/command.html index c7acba4..15c15ed 100644 --- a/doc/command.html +++ b/doc/command.html @@ -29,7 +29,7 @@ </P> <P> The cmd parameter is a integer identifier which is defined in <sndfile.h>. - All of the valid command identifiers have names begining with "SFC_". + All of the valid command identifiers have names beginning with "SFC_". Data is passed to and returned from the library by use of a void pointer. The library will not read or write more than datasize bytes from the void pointer. For some calls no data is required in which case data should be NULL and datasize @@ -254,7 +254,7 @@ Example: <A NAME="SFC_CALC_NORM_SIGNAL_MAX"></A> <H2><BR><B>SFC_CALC_NORM_SIGNAL_MAX</B></H2> <P> -Retrieve the measured normailised maximum signal value. This involves reading +Retrieve the measured normalised maximum signal value. This involves reading through the whole file which can be slow on large files. </P> <P> @@ -455,7 +455,7 @@ Example: </PRE> <DL> <DT>Return value: </DT> - <DD>Returns TRUE if normaisation is on and FALSE otherwise. + <DD>Returns TRUE if normalisation is on and FALSE otherwise. </DL> <!-- ========================================================================= --> @@ -538,7 +538,7 @@ The SF_FORMAT_INFO struct is defined in <sndfile.h> as: </PRE> <P> When sf_command() is called with SF_GET_SIMPLE_FORMAT, the value of the format -field should be the format number (ie 0 <= format <= count value obtained using +field should be the format number (ie 0 <= format <= count value obtained using SF_GET_SIMPLE_FORMAT_COUNT). </P> <P> @@ -550,7 +550,7 @@ Example: sf_command (sndfile, SFC_GET_SIMPLE_FORMAT_COUNT, &count, sizeof (int)) ; - for (k = 0 ; k < count ; k++) + for (k = 0 ; k < count ; k++) { format_info.format = k ; sf_command (sndfile, SFC_GET_SIMPLE_FORMAT, &format_info, sizeof (format_info)) ; printf ("%08x %s %s\n", format_info.format, format_info.name, format_info.extension) ; @@ -559,11 +559,11 @@ Example: <DL> <DT>Return value: </DT> <DD>0 on success and non-zero otherwise. - <DD>The value of the format field of the SF_FORMAT_INFO struct will be an value which + <DD>The value of the format field of the SF_FORMAT_INFO struct will be a value which can be placed in the format field of an SF_INFO struct when a file is to be opened for write. - <DD>The name field will contain a char* pointer to the name of the string ie "WAV (Microsoft 16 bit PCM)". - <DD>The extention field will contain the most commonly used file extension for that file type. + <DD>The name field will contain a char* pointer to the name of the string, eg. "WAV (Microsoft 16 bit PCM)". + <DD>The extension field will contain the most commonly used file extension for that file type. </DL> <!-- ========================================================================= --> @@ -593,9 +593,9 @@ The SF_FORMAT_INFO struct is defined in <sndfile.h> as: </PRE> <P> When sf_command() is called with SF_GET_FORMAT_INFO, the format field is -examined and if (format & SF_FORMAT_TYPEMASK) is a valid format then the struct +examined and if (format & SF_FORMAT_TYPEMASK) is a valid format then the struct is filled in with information about the given major type. -If (format & SF_FORMAT_TYPEMASK) is FALSE and (format & SF_FORMAT_SUBMASK) is a +If (format & SF_FORMAT_TYPEMASK) is FALSE and (format & SF_FORMAT_SUBMASK) is a valid subtype format then the struct is filled in with information about the given subtype. </P> @@ -668,7 +668,7 @@ Example: sf_command (sndfile, SFC_GET_FORMAT_MAJOR_COUNT, &count, sizeof (int)) ; - for (k = 0 ; k < count ; k++) + for (k = 0 ; k < count ; k++) { format_info.format = k ; sf_command (sndfile, SFC_GET_FORMAT_MAJOR, &format_info, sizeof (format_info)) ; printf ("%08x %s %s\n", format_info.format, format_info.name, format_info.extension) ; @@ -681,10 +681,10 @@ directory of the libsndfile source code distribution. <DL> <DT>Return value: </DT> <DD>0 on success and non-zero otherwise. - <DD>The value of the format field will one of the major format identifiers suc as SF_FORMAT_WAV - SF_FORMAT_AIFF. - <DD>The name field will contain a char* pointer to the name of the string ie "WAV (Microsoft)". - <DD>The extention field will contain the most commonly used file extension for that file type. + <DD>The value of the format field will be one of the major format identifiers such as + SF_FORMAT_WAV or SF_FORMAT_AIFF. + <DD>The name field will contain a char* pointer to the name of the string, eg. "WAV (Microsoft)". + <DD>The extension field will contain the most commonly used file extension for that file type. </DL> <!-- ========================================================================= --> @@ -739,7 +739,7 @@ Example: sf_command (sndfile, SFC_GET_FORMAT_SUBTYPE_COUNT, &count, sizeof (int)) ; /* Retrieve all the subtypes supported by the WAV format. */ - for (k = 0 ; k < count ; k++) + for (k = 0 ; k < count ; k++) { format_info.format = k ; sf_command (sndfile, SFC_GET_FORMAT_SUBTYPE, &format_info, sizeof (format_info)) ; if (! sf_format_check (format.info | SF_FORMAT_WAV)) @@ -754,11 +754,11 @@ directory of the libsndfile source code distribution. <DL> <DT>Return value: </DT> <DD>0 on success and non-zero otherwise. - <DD>The value of the format field will one of the major format identifiers such as SF_FORMAT_WAV - SF_FORMAT_AIFF. + <DD>The value of the format field will be one of the major format identifiers such as + SF_FORMAT_WAV or SF_FORMAT_AIFF. <DD>The name field will contain a char* pointer to the name of the string; for instance "WAV (Microsoft)" or "AIFF (Apple/SGI)". - <DD>The extention field will be a NULL pointer. + <DD>The extension field will be a NULL pointer. </DL> <!-- ========================================================================= --> @@ -865,7 +865,7 @@ Example: <A NAME="SFC_FILE_TRUNCATE"></A> <H2><BR><B>SFC_FILE_TRUNCATE</B></H2> <P> -Truncate a file open for write or for read/write. +Truncate a file that was opened for write or read/write. </P> <P> Parameters: |