Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

Commit cba6cf9

Browse files
committed
acb: Update documents
1 parent 6400283 commit cba6cf9

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

PyCriCodecsEx/acb.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,17 @@ def waveform_of(self, index : int) -> List["WaveformTable"]:
144144
raise NotImplementedError(f"Unknown cue reference type: {cue.ReferenceType}")
145145

146146
@dataclass(frozen=True)
147-
class CueItem:
147+
class PackedCueItem:
148+
'''Helper class for read-only cue information'''
149+
148150
CueId: int
151+
'''Cue ID'''
149152
CueName: str
153+
'''Cue name'''
150154
Length: float
151-
Waveforms: list[int] # List of waveform IDs
155+
'''Duration in seconds'''
156+
Waveforms: list[int]
157+
'''List of waveform IDs, corresponds to ACB.get_waveforms()'''
152158

153159
class ACB(UTF):
154160
"""Use this class to read, and modify ACB files in memory."""
@@ -248,15 +254,15 @@ def set_waveforms(self, value: List[HCACodec | ADXCodec | Tuple[AcbEncodeTypes,
248254
pass
249255

250256
@property
251-
def cues(self) -> Generator[CueItem, None, None]:
257+
def cues(self) -> Generator[PackedCueItem, None, None]:
252258
"""Returns a generator of **read-only** Cues.
253259
254260
Cues reference waveform bytes by their AWB IDs, which can be accessed via `waveforms`.
255261
To modify cues, use the `view` property instead.
256262
"""
257263
for name, cue in zip(self.view.CueNameTable, self.view.CueTable):
258264
waveforms = self.view.waveform_of(cue.CueId)
259-
yield CueItem(cue.CueId, name.CueName, cue.Length / 1000.0, [waveform.MemoryAwbId for waveform in waveforms])
265+
yield PackedCueItem(cue.CueId, name.CueName, cue.Length / 1000.0, [waveform.MemoryAwbId for waveform in waveforms])
260266

261267
class ACBBuilder:
262268
"""Use this class to build ACB files from an existing ACB object."""

0 commit comments

Comments
 (0)