Astra.Components.AudioCompressor

Namespace: Astra.Components · Assembly: Astra.Scripting · Tipo: Struct

Sobre esta referência

Assinaturas extraídas semanticamente com Roslyn/MSBuild. Isso confirma a superfície do código deste snapshot; não comprova execução no Android. As descrições vêm dos comentários da API. Membros sem explicação ainda exigem revisão editorial.

Declaração

readonly struct Astra.Components.AudioCompressor

Compressor: Controla picos; com sidechain abaixa este bus quando outro soa. Família Áudio · Mixer.

Referência estudada: https://docs.godotengine.org/en/4.5/classes/class_audioeffectcompressor.html

Interfaces: Astra.Components.IComponentFacade<Astra.Components.AudioCompressor>.

Onde acessar este tipo

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Áudio / Mixer → Compressor.

No Behavior em Play, obtenha a fachada com Object.GetComponent<AudioCompressor>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new AudioCompressor(component) envolve um componente existente; não adiciona um componente à cena.

Roadmap e uso

Áudio: o membro presente nesta referência pertence ao contrato atual. O roadmap registra a família; não há promessa/data individual de evolução para cada membro. Membros ainda sem explicação especializada são indicados como revisão editorial pendente.

Para ler os campos e recursos pelo caminho do editor, use mapa de acesso.

Consulte também Compressor para propriedades, valores iniciais, requisitos e edição em Play.

Membros

Membro	Categoria
.ctor	Method
ReductionDb	Method
Remove	Method
Wrap	Method
Attack	Property
Component	Property
Enabled	Property
InstanceId	Property
IsAlive	Property
Makeup	Property
Mix	Property
Object	Property
Ratio	Property
Release	Property
Sidechain	Property
Threshold	Property
TypeId	Property

.ctor

public AudioCompressor(Astra.Component component)

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Constrói o tipo pela assinatura declarada. Um construtor de fachada envolve um componente existente; um record de configuração só tem efeito quando atribuído ao consumidor.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
component	Astra.Component

ReductionDb

public double ReductionDb()

Redução (dB). Quanto o compressor está abaixando agora

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Redução (dB). Quanto o compressor está abaixando agora

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Remove

public void Remove()

Remove a instância pelo ciclo nativo; dependências e ownership podem recusar.

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Wrap

public static Astra.Components.AudioCompressor Wrap(Astra.Component component)

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Envolve um Component existente após conferir TypeId; não cria componente.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
component	Astra.Component

Attack

public float Attack { get; set; }

Ataque (ms)

Faixa válida: 0.02 a 250.

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Ataque: Tempo em milissegundos para reagir à redução; pequeno reage rápido aos picos.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Component

public Astra.Component Component { get; }

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Handle genérico da instância, usado para operações de reflexão e recursos.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Enabled

public bool Enabled { get; set; }

Ativo. Desligado deixa o sinal passar sem alteração

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Ativo: Desligado deixa o sinal passar sem alteração

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

InstanceId

public ulong InstanceId { get; }

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Distingue a instância no mesmo objeto; importante para componentes múltiplos.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

IsAlive

public bool IsAlive { get; }

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Validade do handle no mundo/geração atuais. Remoção e novo Play invalidam a referência.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Makeup

public float Makeup { get; set; }

Ganho de compensação (dB)

Faixa válida: 0 a 24.

Caminho: Inspector → Compressor → Saída; ou fachada C# em um Behavior.

Uso: Ganho de compensação: Ganho de saída em dB aplicado após compressão; ajuste sem saturar o bus.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Mix

public float Mix { get; set; }

Mistura. Menor que 1 soma o sinal sem compressão (paralela)

Faixa válida: 0 a 1.

Caminho: Inspector → Compressor → Saída; ou fachada C# em um Behavior.

Uso: Mistura: Mistura do sinal comprimido com o original; 1 = processado, valores menores permitem compressão paralela.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Object

public Astra.GameObject Object { get; }

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Objeto dono deste componente; use para resolver composição.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Ratio

public float Ratio { get; set; }

Razão (: 1). 4 reduz 4 dB acima do limiar para cada 1 dB que passa

Faixa válida: 1 a 48.

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Razão: Razão de compressão: 4 significa que 4 dB acima do limiar resultam em 1 dB acima dele.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Release

public float Release { get; set; }

Liberação (ms)

Faixa válida: 1 a 2000.

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Liberação: Tempo em milissegundos para recuperar ganho após cair abaixo do limiar; controla a volta da música no ducking.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Sidechain

public Astra.ObjectReference Sidechain { get; set; }

Sidechain. Comprime quando OUTRO bus soa: música abaixa quando há fala (ducking)

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Sidechain: Comprime quando OUTRO bus soa: música abaixa quando há fala (ducking)

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Threshold

public float Threshold { get; set; }

Limiar (dB). Acima deste nível o volume é reduzido

Faixa válida: -60 a 0.

Caminho: Inspector → Compressor → Compressão; ou fachada C# em um Behavior.

Uso: Limiar: Nível em dB acima do qual o detector provoca redução de ganho; com Sidechain mede o outro Bus.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TypeId

public static string TypeId { get; }

Caminho: Inspector → Compressor; ou fachada C# em um Behavior.

Uso: Identificador nativo usado em AddComponent/GetComponent.

Roadmap deste membro: Áudio. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.