SoundPool (Sound Pool)

The SoundPool module provides APIs for loading, unloading, playing, and stopping playing system sounds, setting the volume, and setting the number of loops.

Before using these APIs, you must call media.createSoundPool to create a SoundPool instance.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import media from '@ohos.multimedia.media';
import audio from '@ohos.multimedia.audio';

PlayParameters

Describes the playback parameters of the sound pool.

These parameters are used to control the playback volume, number of loops, and priority.

System capability: SystemCapability.Multimedia.Media.SoundPool

SoundPool

Implements a sound pool that provides APIs for loading, unloading, playing, and stopping playing system sounds, setting the volume, and setting the number of loops. Before using these APIs, you must call createSoundPool to create a SoundPool instance.

load

load(uri: string, callback: AsyncCallback<number>): void

Loads a sound. This API uses an asynchronous callback to obtain the sound ID. The input parameter uri is a string starting with fd://, which is generated based on the file descriptor (FD) obtained.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let uri:string = "";
    let file: fs.File;
    // Obtain the URI starting with fd://.
    fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file_: fs.File) => {
      file = file_;
      console.info("file fd: " + file.fd);
      uri = 'fd://' + (file.fd).toString()
      soundPool.load(uri, (error: BusinessError, soundId_: number) => {
        if (error) {
          console.error(`load soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
        } else {
          console.info(`load soundPool Success` + JSON.stringify(soundId_))
        }
      });
    }); // '/test_01.mp3' here is only an example. You need to pass in the actual URI.
  }
});

load

load(uri: string): Promise<number>

Loads a sound. This API uses a promise to obtain the sound ID. The input parameter uri is a starting with fd://, which is generated based on the FD obtained.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let uri:string = "";
    let soundID: number = 0;
    let file: fs.File;
    // Obtain the URI starting with fd://.
    fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file_: fs.File) => {
      file = file_;
      console.info("file fd: " + file.fd);
      uri = 'fd://' + (file.fd).toString()
      soundPool.load(uri).then((soundId: number) => {
        console.info('soundPool load uri success');
        soundID = soundId;
      }, (err: BusinessError) => {
        console.error('soundPool load failed and catch error is ' + err.message);
      });
    }); // '/test_01.mp3' here is only an example. You need to pass in the actual URI.
  }
});

load

load(fd: number, offset: number, length: number, callback: AsyncCallback<number>): void

Loads a sound. This API uses an asynchronous callback to obtain the sound ID. The input parameter fd can be manually input or automatically obtained by reading the embedded resource of the application.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let file: fs.File;
    let soundID: number = 0;
    let fileSize: number = 1; // Obtain the size through fs.stat().
    let uri: string = "";
    // Obtain the FD.
    fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file_: fs.File) => {
      file = file_;
      console.info("file fd: " + file.fd);
      uri = 'fd://' + (file.fd).toString()
      soundPool.load(file.fd, 0, fileSize, (error: BusinessError, soundId_: number) => {
        if (error) {
          console.error(`load soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
        } else {
          soundID = soundId_;
          console.info('load success soundid:' + soundId_);
        }
      });
    }); // '/test_01.mp3' here is only an example. You need to pass in the actual URI.
  }
});

load

load(fd: number, offset: number, length: number): Promise<number>

Loads a sound. This API uses a promise to obtain the sound ID. The input parameter fd can be manually input or automatically obtained by reading the embedded resource of the application.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import fs from '@ohos.file.fs';
import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let file: fs.File;
    let soundID: number = 0;
    let fileSize: number = 1; // Obtain the size through fs.stat().
    let uri: string = "";
    // Obtain the FD.
    fs.open('/test_01.mp3', fs.OpenMode.READ_ONLY).then((file_: fs.File) => {
      file = file_;
      console.info("file fd: " + file.fd);
      uri = 'fd://' + (file.fd).toString()
      soundPool.load(file.fd, 0, fileSize).then((soundId: number) => {
        console.info('load success');
        soundID = soundId;
      }, (err: BusinessError) => {
        console.error('soundpool load failed and catch error is ' + err.message);
      });
    });
  }
});

play

play(soundID: number, params: PlayParameters, callback: AsyncCallback<number>): void

Plays a sound. This API uses an asynchronous callback to obtain the audio stream ID.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let soundID: number = 0;
    let streamID: number = 0;
    let playParameters: media.PlayParameters = {
      loop: 3, // The sound loops three times.
      rate: audio.AudioRendererRate.RENDER_RATE_NORMAL, // The sound is played at the original frequency.
      leftVolume: 0.5, // range = 0.0-1.0
      rightVolume: 0.5, // range = 0.0-1.0
      priority: 0, // The sound playback has the lowest priority.
    }
    soundPool.play(soundID, playParameters, (error: BusinessError, streamId: number) => {
      if (error) {
        console.error(`play sound Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        streamID = streamId;
        console.info('play success soundid:' + streamId);
      }
    });
  }
});

play

play(soundID: number, callback: AsyncCallback<number>): void

Plays a sound. This API uses an asynchronous callback to obtain the audio stream ID.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let soundID: number = 0;
    let streamID: number = 0;
    soundPool.play(soundID,  (error: BusinessError, streamId: number) => {
      if (error) {
        console.error(`play sound Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        streamID = streamId;
        console.info('play success soundid:' + streamId);
      }
    });
  }
});

play

play(soundID: number, params?: PlayParameters): Promise<number>

Plays a sound. This API uses a promise to obtain the audio stream ID.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let soundID: number = 0;
    let streamID: number = 0;
    let playParameters: media.PlayParameters = {
      loop: 3, // The sound is played four times (three loops).
      rate: audio.AudioRendererRate.RENDER_RATE_NORMAL, // The sound is played at the original frequency.
      leftVolume: 0.5, // range = 0.0-1.0
      rightVolume: 0.5, // range = 0.0-1.0
      priority: 0, // The sound playback has the lowest priority.
    }

    soundPool.play(soundID, playParameters).then((streamId: number) => {
      console.info('play success');
      streamID = streamId;
    },(err: BusinessError) => {
      console.error('soundpool play failed and catch error is ' + err.message);
    });
  }
});

stop

stop(streamID: number, callback: AsyncCallback<void>): void

Stops playing a sound. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    soundPool.stop(streamID, (error: BusinessError) => {
      if (error) {
        console.error(`stop sound Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('stop success');
      }
    })
  }
});

stop

stop(streamID: number): Promise<void>

Stops playing a sound. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    soundPool.stop(streamID).then(() => {
      console.info('stop success');
    }, (err: BusinessError) => {
      console.error('soundpool load stop and catch error is ' + err.message);
    });
  }
});

setLoop

setLoop(streamID: number, loop: number, callback: AsyncCallback<void>): void;

Sets the loop mode for an audio stream. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    // Set the number of loops to 2.
    soundPool.setLoop(streamID, 2, (error: BusinessError) => {
      if (error) {
        console.error(`setLoop soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('setLoop success streamID:' + streamID);
      }
    });
  }
});

setLoop

setLoop(streamID: number, loop: number): Promise<void>

Sets the loop mode for an audio stream. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    // Set the number of loops to 1.
    soundPool.setLoop(streamID, 1).then(() => {
      console.info('setLoop success streamID:' + streamID);
    }).catch((err: BusinessError) => {
      console.error('soundpool setLoop failed and catch error is ' + err.message);
    });
  }
});

setPriority

setPriority(streamID: number, priority: number, callback: AsyncCallback<void>): void

Sets the priority for an audio stream. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    // Set the priority to 1.
    soundPool.setPriority(streamID, 1, (error: BusinessError) => {
      if (error) {
        console.error(`setPriority soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('setPriority success streamID:' + streamID);
      }
    });
  }
});

setPriority

setPriority(streamID: number, priority: number): Promise<void>

Sets the priority for an audio stream. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    // Set the priority to 1.

    soundPool.setPriority(streamID, 1).then(() => {
      console.info('setPriority success');
    }, (err: BusinessError) => {
      console.error('soundpool setPriority failed and catch error is ' + err.message);
    });
  }
});

setRate

setRate(streamID: number, rate: audio.AudioRendererRate, callback: AsyncCallback<void>): void

Sets the playback rate for an audio stream. This API uses an asynchronous callback to return the result.

NOTE This API is available in OpenHarmony 4.0. The function implementation depends on the device. Currently, only the RK3568 development board supports the playback rate setting.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    let selectedAudioRendererRate: audio.AudioRendererRate = audio.AudioRendererRate.RENDER_RATE_NORMAL; // The sound is played at the original frequency.
    // Call play() to obtain the stream ID.
    soundPool.setRate(streamID, selectedAudioRendererRate, (error: BusinessError) => {
      if (error) {
        console.error(`setRate soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('setRate success streamID:' + streamID);
      }
    })
  }
});

setRate

setRate(streamID: number, rate: audio.AudioRendererRate): Promise<void>

Sets the playback rate for an audio stream. This API uses a promise to return the result.

NOTE This API is available in OpenHarmony 4.0. The function implementation depends on the device. Currently, only the RK3568 development board supports the playback rate setting.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    let selectedAudioRendererRate: audio.AudioRendererRate = audio.AudioRendererRate.RENDER_RATE_NORMAL; // The sound is played at the original frequency.
    // Call play() to obtain the stream ID.
    soundPool.setRate(streamID, selectedAudioRendererRate).then(() => {
      console.info('setRate success');
    }, (err: BusinessError) => {
      console.error('soundpool setRate failed and catch error is ' + err.message);
    });
  }
});

setVolume

setVolume(streamID: number, leftVolume: number, rightVolume: number, callback: AsyncCallback<void>): void

Sets the volume for an audio stream. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.
    // Set the volume to 0.5.
    soundPool.setVolume(streamID, 0.5, 0.5, (error: BusinessError) => {
      if (error) {
        console.error(`setVolume soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('setVolume success streamID:' + streamID);
      }
    })
  }
});

setVolume

setVolume(streamID: number, leftVolume: number, rightVolume: number): Promise<void>

Sets the volume for an audio stream. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let streamID: number = 0;
    // Call play() to obtain the stream ID.

    soundPool.setVolume(streamID, 0.5, 0.5).then(() => {
      console.info('setVolume success');
    }, (err: BusinessError) => {
      console.error('soundpool setVolume failed and catch error is ' + err.message);
    });
  }
});

unload

unload(soundID: number, callback: AsyncCallback<void>): void

Unloads a sound. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let soundID: number = 0;
    // Call load() to obtain the sound ID.
    soundPool.unload(soundID, (error: BusinessError) => {
      if (error) {
        console.error(`unload soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('unload success:');
      }
    })
  }
});

unload

unload(soundID: number): Promise<void>

Unloads a sound. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    let soundID: number = 0;
    // Call load() to obtain the sound ID.

    soundPool.unload(soundID).then(() => {
      console.info('unload success');
    }, (err: BusinessError) => {
      console.error('soundpool unload failed and catch error is ' + err.message);
    });
  }
});

release

release(callback: AsyncCallback<void>): void

Releases this SoundPool instance. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.release((error: BusinessError) => {
      if (error) {
        console.error(`release soundPool Error: errCode is ${error.code}, errMessage is ${error.message}`)
      } else {
        console.info('release success');
      }
    })
  }
});

release

release(): Promise<void>

Releases this SoundPool instance. This API uses a promise to return the result.

System capability: SystemCapability.Multimedia.Media.SoundPool

Return value

Error codes

For details about the error codes, see Media Error Codes.

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.release().then(() => {
      console.info('release success');
    }, (err: BusinessError) => {
      console.error('soundpool release failed and catch error is ' + err.message);
    });
  }
});

on('loadComplete')

on(type: 'loadComplete', callback: Callback<number>): void

Subscribes to events indicating that a sound finishes loading.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.on('loadComplete', (soundId: number) => {
      console.info('loadComplete success, soundId: ' + soundId)
    })
  }
});

off('loadComplete')

off(type: 'loadComplete'): void

Unsubscribes from events indicating that a sound finishes loading.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.off('loadComplete')
  }
});

on('playFinished')

on(type: 'playFinished', callback: Callback<void>): void

Subscribes to events indicating that a sound finishes playing.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.on('playFinished', () => {
      console.info('playFinished success')
    });
  }
});

off('playFinished')

off(type: 'playFinished'): void

Unsubscribes from events indicating that a sound finishes playing.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.off('playFinished')
  }
});

on('error')

on(type: 'error', callback: ErrorCallback): void

Subscribes to error events of this SoundPool instance. This event is used only for error prompt.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

The SoundPool class provides the following error types:

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.on('error', (error: BusinessError) => {
      console.info('error happened,and error message is :' + error.message)
      console.info('error happened,and error code is :' + error.code)
    })
  }
});

off('error')

off(type: 'error'): void

Unsubscribes from error events of this SoundPool instance.

System capability: SystemCapability.Multimedia.Media.SoundPool

Parameters

Example

import { BusinessError } from '@ohos.base';

// Create a SoundPool instance.
let soundPool: media.SoundPool;
let audioRendererInfo: audio.AudioRendererInfo = {
  usage: audio.StreamUsage.STREAM_USAGE_MUSIC,
  rendererFlags: 1
}
media.createSoundPool(5, audioRendererInfo, (error: BusinessError, soundPool_: media.SoundPool) => {
  if (error) {
    console.error(`createSoundPool failed`)
    return;
  } else {
    soundPool = soundPool_;
    console.info(`createSoundPool success`)
    soundPool.off('error')
  }
});