qiskit-documentation/docs/api/qiskit/0.41/qiskit.pulse.builder.play.mdx

32 lines
828 B
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: play
description: API reference for qiskit.pulse.builder.play
in_page_toc_min_heading_level: 1
python_api_type: function
python_api_name: qiskit.pulse.builder.play
---
# qiskit.pulse.builder.play
<Function id="qiskit.pulse.builder.play" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py" signature="play(pulse, channel, name=None)">
Play a `pulse` on a `channel`.
Examples:
```python
from qiskit import pulse
d0 = pulse.DriveChannel(0)
with pulse.build() as pulse_prog:
pulse.play(pulse.Constant(10, 1.0), d0)
```
**Parameters**
* **pulse** (`Union`\[`Pulse`, `ndarray`]) Pulse to play.
* **channel** (`PulseChannel`) Channel to play pulse on.
* **name** (`Optional`\[`str`]) Name of the pulse.
</Function>