diguySoundInstance

Generated from diguySoundInstance.h

DI-Guy API Version 12.5.1

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

Includes: declspec_diguy.h

Contents:

Alphabetical Index

class diguySoundInstance

class BDI_DECLSPEC_diguy diguySoundInstance
{
public:
    const char* get_name();
    const char* get_type_name();
    int play(double offset = 0.0);
    int get_is_playing();
    int get_is_stopping();
    int stop(float rampdown_time = 0.0f);
    int set_automatic_destroy_flag();
    void set_is_3d_sound_flag(int is_3d_sound_flag);
    int get_is_3d_sound_flag();

function diguySoundInstance::get_name

Prototype:
const char* get_name();
Returns:

name of the sound used by the sound instance.
Callable From:

C++
Script

function diguySoundInstance::get_type_name

Prototype:
const char* get_type_name();
Returns:

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

C++
Script

function diguySoundInstance::play

Prototype:
int play(double offset = 0.0);
Description:

This function causes the sound to play immediately, starting from the specified time offset. The sound will continue until it has completed, or it is stopped.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguySoundInstance::get_is_playing

Prototype:
int get_is_playing();
Returns:

1 if the sound is playing; 0 if not
Callable From:

C++
Script

function diguySoundInstance::get_is_stopping

Prototype:
int get_is_stopping();
Returns:

1 if the sound is stopping; 0 if not
Callable From:

C++
Script

function diguySoundInstance::stop

Prototype:
int stop(float rampdown_time = 0.0f);
Description:

This function causes this sound to stop. It does not destroy the sound instance. The sound instance can be played again if desired.
Arguments

rampdown_time how long to take fading out the sound

*b Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguySoundInstance::set_automatic_destroy_flag

Prototype:
int set_automatic_destroy_flag();
Description:

This function causes the sound instance to be automatically deleted when the sound has completed. No further calls through the diguySoundInstance object can or should be made, so this function should only be called once all durations, reps, etc. have been set.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguySoundInstance::set_is_3d_sound_flag

Prototype:
void set_is_3d_sound_flag(int is_3d_sound_flag);
Description:

This function sets whether the sound is "ambient" (it will be equally audible from everywhere within the world), or "3d" (it will move with the character.
Arguments

is_3d_sound_flag pass 1 to make the sound 3d; pass 0 to make the sound ambient
Callable From:

C++
Script

function diguySoundInstance::get_is_3d_sound_flag

Prototype:
int get_is_3d_sound_flag();
Returns:

1 if the sound is 3d; 0 if not
Callable From:

C++
Script

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.