1
0

TranscriptionSuccessfulEvent.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Marcel Klehr <mklehr@gmx.net>
  5. *
  6. * @author Marcel Klehr <mklehr@gmx.net>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. */
  23. namespace OCP\SpeechToText\Events;
  24. use OCP\Files\File;
  25. /**
  26. * This Event is emitted when a transcription of a media file happened successfully
  27. * @since 27.0.0
  28. */
  29. class TranscriptionSuccessfulEvent extends AbstractTranscriptionEvent {
  30. /**
  31. * @since 27.0.0
  32. */
  33. public function __construct(
  34. int $fileId,
  35. ?File $file,
  36. private string $transcript,
  37. ?string $userId,
  38. string $appId,
  39. ) {
  40. parent::__construct($fileId, $file, $userId, $appId);
  41. }
  42. /**
  43. * @since 27.0.0
  44. * @return string The transcript of the media file
  45. */
  46. public function getTranscript(): string {
  47. return $this->transcript;
  48. }
  49. }