diguySound

Generated from diguySound.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguySound.h. Do not edit this file directly; the changes will be lost.

Includes: declspec_diguy.h

Contents:

Alphabetical Index

This class is represents a sound file on disk.

All Function in this class are callable from:

C++
Script

Unless otherwise noted.

class diguySound

class BDI_DECLSPEC_diguy diguySound
{
public:
    const char* get_name();
    const char* get_type_name();
    int set_sound_filename(const char* sound_filename);
    const char* get_sound_filename();
    int set_phoneme_filename(const char* phoneme_filename);
    const char* get_phoneme_filename();
    float get_duration();
    int get_samples_per_second();
    int get_number_of_channels();
    int get_bit_depth();

function diguySound::get_name

Prototype:
const char* get_name();
Returns:

name of this object

function diguySound::get_type_name

Prototype:
const char* get_type_name();
Returns:

type name of the object; this value will never be NULL

function diguySound::set_sound_filename

Prototype:
int set_sound_filename(const char* sound_filename);
Description:

This function sets the name of the file that contains the waveform data for the sound. The file should typically be located in the $(DIGUY)/sfx or $(DIGUY)customsfx directory.
Arguments:

sound_filename name of file containing waveform data
Returns:

0 on success, -1 on failure

function diguySound::get_sound_filename

Prototype:
const char* get_sound_filename();
Returns:

name of file containing waveform data for sound as set by set_sound_filename(); will never be NULL, but may be the empty string ""

function diguySound::set_phoneme_filename

Prototype:
int set_phoneme_filename(const char* phoneme_filename);
Description:

This function sets the name of the file that contains the phoneme data for the sound. The file should typically be located in the same place as its waveform counterpart.

Phoneme files are optional.
Arguments:

phoneme_filename name of file containing phoneme data
Returns:

0 on success, -1 on failure

function diguySound::get_phoneme_filename

Prototype:
const char* get_phoneme_filename();
Returns:

name of file containing phoneme data as set by set_phoneme_filename()

function diguySound::get_duration

Prototype:
float get_duration();
Returns:

the length of the sound in seconds

function diguySound::get_samples_per_second

Prototype:
int get_samples_per_second();
Returns:

the number of samples per second

function diguySound::get_number_of_channels

Prototype:
int get_number_of_channels();
Returns:

the number of sound channels either 1 (mono) or 2 (stereo)

function diguySound::get_bit_depth

Prototype:
int get_bit_depth();
Returns:

the bit depth of a sound, either 8 or 16

Alphabetical Index

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.