Group

create

Creates a new group

moises.group.create

Parameters

ParameterTypeDescription
namestringThe name of the group
idstringThe ID of the group
typestringThe type of the group
ordernumberThe order of the group
solobooleanWhether the group is solo
mutedbooleanWhether the group is muted
pannumberThe pan of the group
volumenumberThe volume of the group
optionsObjectAdditional options for the group

Returns:

Promise<Object> - Promise that resolves with the created group object

Return Object Structure:

// When the promise resolves, you get:
{
  groupId: "example" // 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 groupId = await moises.group.create({ name: "My Group" })
console.log(groupId) // "group-123"

This file is automatically generated. Do not edit manually.