Skip to content

Added optional properties when starting archiving #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added optional properties when starting archiving #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2c30f1
Added optional properties when starting archiving
mfiyalka Jan 30, 2023
c8a47b3
Merge branch 'main' into fix_optional_properties
mfiyalka Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/OpenTok/OpenTok.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,14 @@ public function startArchive(string $sessionId, $options = []): Archive
'resolution' => null,
'streamMode' => StreamMode::AUTO,
);
if (isset($options['multiArchiveTag'])) {
$defaults['multiArchiveTag'] = $options['multiArchiveTag'];
Validators::validateArchiveMultiArchiveTag($defaults['multiArchiveTag']);
}
if (isset($options['layout'])) {
$defaults['layout'] = $options['layout'];
Validators::validateArchiveLayout($defaults['layout']);
}
$options = array_merge($defaults, array_intersect_key($options, $defaults));
list($name, $hasVideo, $hasAudio, $outputMode, $resolution, $streamMode) = array_values($options);

Expand Down
16 changes: 16 additions & 0 deletions src/OpenTok/Util/Validators.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,22 @@ public static function validateArchiveId($archiveId)
);
}
}
public static function validateArchiveMultiArchiveTag($multiArchiveTag)
{
if ($multiArchiveTag != null && !is_string($multiArchiveTag) /* TODO: length? */) {
throw new InvalidArgumentException(
'The multiArchiveTag was not a string: ' . print_r($multiArchiveTag, true)
);
}
}
public static function validateArchiveLayout($layout)
{
if ($layout != null && !is_array($layout)) {
throw new InvalidArgumentException(
'The layout was not an array: ' . print_r($layout, true)
);
}
}
public static function validateArchiveData($archiveData)
{
if (!self::$archiveSchemaUri) {
Expand Down