Skip to content
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.

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

Allow captions enableRollUp to be configured #4332

Closed
nigelmegitt opened this issue Dec 14, 2023 · 7 comments · Fixed by #4336
Closed

Allow captions enableRollUp to be configured #4332

nigelmegitt opened this issue Dec 14, 2023 · 7 comments · Fixed by #4336
Assignees
Milestone

Comments

@nigelmegitt
Copy link
Contributor

At

}, previousISDState, true /*enableRollUp*/);

the enableRollUp parameter is forced to true. This is not always what clients want, and in particular is a significant change to the normal expected subtitle behaviour in the UK. Add a way to set some configuration to allow this to be controlled, for example by passing a value in via the config.settings object.

@dsilhavy
Copy link
Collaborator

@nigelmegitt Can you provide a PR for the new settings flag?

@nigelmegitt
Copy link
Contributor Author

@dsilhavy I could. Do we have any design documentation about how settings should be structured? I'm thinking that we would have settings.captions.enableRollUp and set it to true if absent to maintain current behaviour. Then any other captions-related settings would also go under settings.captions.

@dsilhavy
Copy link
Collaborator

@dsilhavy I could. Do we have any design documentation about how settings should be structured? I'm thinking that we would have settings.captions.enableRollUp and set it to true if absent to maintain current behaviour. Then any other captions-related settings would also go under settings.captions.

We do have settings.streaming.text would it fit into that category:

  text: {
    defaultEnabled: true,
    extendSegmentedCues: true,
    webvtt: {
      customRenderingEnabled: false
    }
  }
@nigelmegitt
Copy link
Contributor Author

nigelmegitt commented Dec 15, 2023

Ah thanks I just found that too. Given that this is imscJS-specific, what do you think is best practice? Looks like maybe this would work:

settings = {
           ...,
           text: {
               defaultEnabled: true,
               extendSegmentedCues: true,
               imsc: {
                   enableRollUp: true,
               },
               webvtt: {
                   customRenderingEnabled: false
               }
           },
}
@dsilhavy
Copy link
Collaborator

Ah thanks I just found that too. Given that this is imscJS-specific, what do you think is best practice? Looks like maybe this would work:

settings = {
           ...,
           text: {
               defaultEnabled: true,
               extendSegmentedCues: true,
               imsc: {
                   enableRollUp: true,
               },
               webvtt: {
                   customRenderingEnabled: false
               }
           },
}

That looks good thanks

@nigelmegitt
Copy link
Contributor Author

I see that we have the same issue with displayForcedOnlyMode, so I'll add that in at the same time.

@nigelmegitt
Copy link
Contributor Author

PR opened.

Tests?

Please advise if you think additional tests are needed, and if so, I'd appreciate hints about how to add them. I did not find an obvious location where these kind of settings could be tested; I'm also not sure how to go about testing roll-up mode since it is a content-dependent animation.

Testing displayForcedOnly is a bit easier, because in the presence of subtitles without itts:forcedDisplay="true", if that mode is set then no subtitles should display. However, if we are testing this then we should provide some alternate subtitles where itts:forcedDisplay="true" and check that in that case the subtitles do display.

@dsilhavy dsilhavy added this to the 4.7.4 milestone Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants