Group
get
Gets a group by its ID
moises.group.get
Parameters
Parameter | Type | Description |
---|---|---|
groupId | string | The ID of the group to get |
Returns:
Promise<Object>
- Promise that resolves with the group object
Return Object Structure:
// When the promise resolves, you get:
{
id: "example", // string
type: "example", // string
name: "example", // string
volume: 0, // number
isSolo: false, // boolean
isMuted: false, // boolean
tracks: string[] // Array<string>
}
Usage Example
import { initMoisesExtension } from '@moises.ai/extension'
const useMoisesExtension = initMoisesExtension({
id: 'id',
name: 'name',
description: 'description',
icon: 'icon',
version: 'version',
author: 'author'
})
const { moises } = useMoisesExtension()
const group = await moises.group.get({ groupId: 'group-123' })
console.log(group.name) // "My Group"
This file is automatically generated. Do not edit manually.